PIPEFORCE REST API (v3)

Download OpenAPI specification:Download

Last update: 2025-01-13T16:54:13.771688Z

This lists all PIPEFORCE RESTFul endpoints accessible via the hub service.

As base path use https://hub-ns.pipeforce.net/api/v3/ and replace ns by the namespace of your target PIPEFORCE instance.

This documentation contains four main sections:

Pipeline API: All endpoints related to store, read, delete and execute pipelines. See here fore more details about Pipelines
Property API: All endpoints related to store, read and delete properties. See here for more details about Properties and the Property Store
Command API: All endpoints related to execute a specific command. Note: Only POST version of these endpoints are listed where the request body becomes the body to the command. But most of them can be used also be called using the HTTP GET method. See here for more details about calling Commands remotely
PelUtils: The documentation of all PEL utils. Not a real Rest API doc but in order to have all most recent pipeline element docs consolidated at the same place you can find this also here. Every PEL util starts with @. See here for more details about PEL Utils.

In order to successfully execute most of these endpoints, authentication is required and therefore the Authorization header must be set properly. For more details see the Authentication documentation.

For further details, tutorials and examples, go to the PIPEFORCE Academy.

Pipeline API

/pipeline

Adhoc executes the pipeline script provided in the request body and returns the result in the response body. Pipeline script can be a YAML, JSON or Multipart in the body.
See the Content-Type header for more details to specify the pipeline type.

header Parameters

Content-Type

required

string

If set to application/yaml expects a YAML pipeline script in the body which will be parsed and executed.
If set to application/json expects a JSON pipeline script in the body which will be parsed and executed.
If set to multipart/form-data expects in the body one part with name pipeline containing the pipeline (with part Content-Type set to application/json or application/yaml (default)) and one or more file upload parts with name file which will be converted to a content collection and provided in the message body.

Request Body schema:
application/yaml

	object
	object
	Array of objects

Responses

Request samples

Payload

Content type

application/yaml

No sample

Response samples

500

Content type

application/json

{"status": "error",
"statusCode": 500,
"statusMessage": "INTERNAL_SERVER_ERROR",
"value": {"type": "SomeException",
"statusCode": 500,
"message": "string",
"uuid": "string",
"time": 0,
"namespace": "string",
"domain": "string",
"auth": "string",
"spanId": "string",
"traceId": "string",
"pipelinePath": "string",
"commandName": "string",
"commandLine": "string",
"commandPosition": "string",
"details": "string",
"logs": "string"
}
}

/pipeline:{path}

Stores the pipeline from the body into the property store at given {path}.
If such a pipeline already exists at this path, updates the existing one. Otherhwise, creates a new one.
The pipeline in the body can be a JSON, YAML or a x-www-form-urlencoded query string.

path Parameters

path

required

string >= 1

The property path of the pipeline in the property store. Must be of format: global/app/{app}/pipeline/{pipeline}. Any other pipeline location is not allowed by this endpoint.

header Parameters

Content-Type

required

string

If set to application/yaml expects a YAML pipeline script in the body.
If set to application/json expects a JSON pipeline script in the body.
If set to x-www-form-urlencoded expects a pipeline query string in the body. For details of this format, see here: URL encoded Pipeline.

Responses

Response samples

200

Content type

application/json

{"result": "create",
"path": "string",
"uuid": "string",
"correlationId": "string"
}

/pipeline:{path}

Executes the persisted pipeline given by path and returns it result. The body of the POST request will become the body to the pipeline.

path Parameters

path

required

string >= 1

The property path of the pipeline in the property store. Must be of format: global/app/{app}/pipeline/{pipeline}. Any other pipeline location is not allowed by this endpoint.

Responses

Response samples

500

Content type

application/json

{"status": "error",
"statusCode": 500,
"statusMessage": "INTERNAL_SERVER_ERROR",
"value": {"type": "SomeException",
"statusCode": 500,
"message": "string",
"uuid": "string",
"time": 0,
"namespace": "string",
"domain": "string",
"auth": "string",
"spanId": "string",
"traceId": "string",
"pipelinePath": "string",
"commandName": "string",
"commandLine": "string",
"commandPosition": "string",
"details": "string",
"logs": "string"
}
}

/pipeline:{path}

Loads the pipeline script from property store by given path and returns it.

path Parameters

path

required

string >= 1

The property path of the pipeline in the property store. Must be of format: global/app/{app}/pipeline/{pipeline}. Any other pipeline location is not allowed by this endpoint.

Responses

Response samples

200

Content type

application/yaml

No sample

/pipeline:{path}

Deletes the persisted pipeline at path from the property store.

path Parameters

path

required

string >= 1

The property path of the pipeline in the property store. Must be of format: global/app/{app}/pipeline/{pipeline}. Any other pipeline location is not allowed by this endpoint.

/pipeline:uuid:{uuid}

Executes the persisted pipeline given by uuid and returns it result. The body of the POST request will become the body to the pipeline.

/pipeline:uuid:{uuid}

Uploads the pipeline given in the body and overwrites the pipeline at uuid in the property store.

/pipeline:uuid:{uuid}

Returns the persisted pipeline given by uuid.

/pipeline:uuid:{uuid}

Deletes the persisted pipeline given by uuid.

Property API

/property:{path}

Stores the property from the body into the property store. If such a property already exists, updates the existing one.

/property:{path}

Returns the property at given path.

/property:{path}

Deletes the property at given path.

/property-uuid:{uuid}

Updates the property value in property store given in body at property with given uuid.

/property-uuid:{uuid}

Returns the property value from property store with given uuid.

/property-uuid:{uuid}

Deletes the property from property store with given uuid.

/resource/{app}/{path}

Returns the value of the property given by {path} relative to the app given by {app} as a static resource.

ai

ai.intent.detect

Detects the intent based on a given advice configuration and the input message
and can directly execute a command linked to the intent.

Search Academy for more details about: ai.intent.detect.

query Parameters

advice	string The advice configuration to apply on the input.
runDetectedCommand	string Should the detected command be directly executed? After it has been executed, the body of the executed command will be set as output. Otherwise, if this param is false, only the intent JSON set passed to body.
secret	string Refers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.

Responses

ai.prompt.send

This commands constructs a prompt from given parameters and input and sends it to the AI.

Search Academy for more details about: ai.prompt.send.

query Parameters

messages	string The list of messages to be send. Each message must define at least the fields role and content.
prompt	string (default) The system message to be send to the AI.
secret	string Refers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.

Responses

app

app.config.list

Returns the configuration of all apps the currently logged-in user is allowed to see.

Search Academy for more details about: app.config.list.

query Parameters

app	string The name of the app to load the config from (not its path). If null or empty, the config of all apps will be returned instead. If not found, empty JSON list is returned.
async	boolean Run the installation async?
branch	string The GitHub repo branch, commit or tag reference to be used. If null or empty, the default branch of the GitHub repo will be used. This parameter will be ignored in case no value for github is given.
credentials	string DEPRECATED. Use param secret instead.
github	string A GitHub repository path (owner/reponame) to download the app resources from. For example acme/myproject. If no credentials are given, the github-default secret will be used if exists. Otherwise, repo is expected to be a public one. If this parameter is missing, the app sources are expected in the body as zip file content instead.
runTests	boolean Run the tests of the app after installation?
secret	string Refers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.

Responses

app.config.value.get

Returns the value of given app config entry.

Search Academy for more details about: app.config.value.get.

query Parameters

appName	string The optional app name to search the config inside.
key required	string The config key those value to return.

Responses

app.install

Installs an app into the property store. The app can be located on GitHub or can be provided as zip file content in the body. If app is located in a private GitHub repo, the param secret must be set or the default secret github-default-readonly must exist which will be used as fallback in case no secret is set as param here.

Search Academy for more details about: app.install.

query Parameters

async	boolean Run the installation async?
branch	string The GitHub repo branch, commit or tag reference to be used. If null or empty, the default branch of the GitHub repo will be used. This parameter will be ignored in case no value for github is given.
credentials	string DEPRECATED. Use param secret instead.
github	string A GitHub repository path (owner/reponame) to download the app resources from. For example acme/myproject. If no credentials are given, the github-default secret will be used if exists. Otherwise, repo is expected to be a public one. If this parameter is missing, the app sources are expected in the body as zip file content instead.
overwrite	boolean What to do if app with this key already exists? If true, the existing app will be uninstalled and replaced by this new version. Otherwise, an attempt to install an existing app will cause an error. Persisted data in data, system or object folder wont be deleted in any case. In order to delete such data you have to use command app.uninstall.
runTests	boolean Run the tests of the app after installation?
secret	string Refers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.

Responses

app.marketplace.search

Searches the marketplace for apps ready to be installed.
Note: This command is limited to max. 10 calls per minute.

Search Academy for more details about: app.marketplace.search.

query Parameters

license	string Limit the search to app repos with given exact license keyword only.
order	string Orders the result desc or asc.
page	string The 1-based page number to return.
results	string Max. number of results per page.
searchInDesc	boolean Search for searchString in the app repo description?
searchInName	boolean Search for searchString in the app repo name?
searchInReadme	boolean Search for searchString in the app repo README file?
searchInTopics	boolean Search for searchString in the repo topics?
searchString	string The text to search for.
secret	string Refers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.
sort	string Sorts the results by author-date or committer-date or (best-match). If null or empty, best-match will be used as default.

Responses

app.name.list

Returns the names of all installed global apps. This command is optimized for best performance. So prefer to use it instead of reading properties or property paths with pattern matching.

Search Academy for more details about: app.name.list.

query Parameters

async	boolean Run the installation async?
branch	string The GitHub repo branch, commit or tag reference to be used. If null or empty, the default branch of the GitHub repo will be used. This parameter will be ignored in case no value for github is given.
credentials	string DEPRECATED. Use param secret instead.
github	string A GitHub repository path (owner/reponame) to download the app resources from. For example acme/myproject. If no credentials are given, the github-default secret will be used if exists. Otherwise, repo is expected to be a public one. If this parameter is missing, the app sources are expected in the body as zip file content instead.
runTests	boolean Run the tests of the app after installation?
secret	string Refers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.

Responses

app.resource.get

Returns resources from inside a given app resource folder of the property store.

Search Academy for more details about: app.resource.get.

query Parameters

app required	string The name of the app to load the resource from
async	boolean Run the installation async?
branch	string The GitHub repo branch, commit or tag reference to be used. If null or empty, the default branch of the GitHub repo will be used. This parameter will be ignored in case no value for github is given.
credentials	string DEPRECATED. Use param secret instead.
github	string A GitHub repository path (owner/reponame) to download the app resources from. For example acme/myproject. If no credentials are given, the github-default secret will be used if exists. Otherwise, repo is expected to be a public one. If this parameter is missing, the app sources are expected in the body as zip file content instead.
path required	string The path relative to the app's resource folder of the resource to be returned.
runTests	boolean Run the tests of the app after installation?
secret	string Refers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.

Responses

app.tile.list

Returns the list of tiles the currently logged-in user is allowed to see.

Search Academy for more details about: app.tile.list.

query Parameters

app

required

string

The name (not path) of the global app to load the tiles from.

Responses

app.uninstall

Uninstalls the given app.

Search Academy for more details about: app.uninstall.

query Parameters

appKey

string

The key of the app to uninstall. For example: global/app/myapp.

Responses

app.update

Deprecated. Use app.install with param update:true instead. Updates the given apps.

Search Academy for more details about: app.update.

query Parameters

async	boolean Run the installation async?
branch	string The GitHub repo branch, commit or tag reference to be used. If null or empty, the default branch of the GitHub repo will be used. This parameter will be ignored in case no value for github is given.
credentials	string DEPRECATED. Use param secret instead.
github	string A GitHub repository path (owner/reponame) to download the app resources from. For example acme/myproject. If no credentials are given, the github-default secret will be used if exists. Otherwise, repo is expected to be a public one. If this parameter is missing, the app sources are expected in the body as zip file content instead.
runTests	boolean Run the tests of the app after installation?
secret	string Refers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.

Responses

assert

Evaluates a given PEL conditions and throws an error in case a condition is invalid.

Search Academy for more details about: assert.

query Parameters

actual	string The actual value to be compared with the expect value. If both values do not match, the assert fails.
body.equals	string The value of this param is compared to the body. If different, exception is thrown. Can be a PE.
equals	string Compares the result of param value with this. If not equal, throws exception. Can be a PE.
expect	string The value to be expected and to be compared with the actual value.
false	string A PE which must evaluate to false.
message	string An optional message to describe the assert. Can be a PE.
true	string (default) A PE which must evaluate to true.
value	string The value to be used for comparison. Can be a PE.

Responses

audit

audit.log

Logs an audit step. Audit logs are treated differently since they need to be archived in some cases for compliance reasons.

Search Academy for more details about: audit.log.

query Parameters

level	string By default all audit log entries are created with INFO level. For very sensitive or problematic actions, this can be increased to WARN or ERROR.
message required	string (default) The message to log. Can be a string or a pipe expression. If null or empty, the full pipe message will be logged.
principal	string The optional information about the principal (user, system, account, ...) who initiated this. If null or empty, the info of the currently logged-in principal is used instead.

Responses

barcode

barcode.create

Creates a barcode from a dynamic format.

Search Academy for more details about: barcode.create.

query Parameters

format	string The dynamic format of the barcode to be created. One of: AZTEC, CODABAR, CODE_39, CODE_93, CODE_128, DATA_MATRIX, EAN_8, EAN_13, ITF, PDF_417, QR_CODE, UPC_A, UPC_E
height	string The height of the barcode. If empty, the default size is used.
text	string (default) The text value to be transformed to a barcode.
width	string The width of the barcode. If empty, the default size is used.

Responses

barcode.read

Reads a barcode from a dynamic PNG format. Expects the barcode image as content object in the body. Detects the barcode type automatically. By default returns the text extracted from the barcode in the body.

Search Academy for more details about: barcode.read.

Responses

body

body.delete

Sets the value in the body to null. Deletes any existing value in the body.

Search Academy for more details about: body.delete.

Responses

body.filter

DEPRECATED. Converts the input body to JSON and then filters the input body and removes any properties not matching the given filter. Throws exception if input body cannot be converted to JSON.Does nothing, if input body is null or empty. If the first level of the body is a list, appliesthe filter to each element inside the list. This command can be used for example to filter outsensitive information or to shrink a big result set for performance reasons.

Search Academy for more details about: body.filter.

query Parameters

properties

string

A comma separated list of first-level properties to be shown. If set, only those properties of the first level will be returned, those are listed here. All other properties will be omitted. For example to filter a user entity in the body with filter: id,username would return only the id and the username of the user. If not set, the body will not be converted and filtered at all and returned unchanged.

removeKey

format	string Converts a string value to the given target format if possible. If set to 'auto' tries to detect the target format by inspecting the value string. If set to 'none' doesnt apply any conversion.
value	string (default) A string or an expression to be used as the value to be set. If missing, null is set.

Responses

bot

bot.prompt

Sends a prompt to a bot endpoint and returns the answer.

Search Academy for more details about: bot.prompt.

query Parameters

maxTokens	number The maximum number of tokens to return in the response.
secret	string The name of the secret which contains the token to connect to the bot backend. If not given as parameter will lookup in the secret store using the default name.

Responses

cache

cache.clear

Clears the underlying central cache and removes any entry those time to live has been expired. Can also be used to remove a single entry from the cache.

Search Academy for more details about: cache.clear.

query Parameters

expiredOnly	string Clean only evicted and expired entries? If false, all entries will be removed!
key	string (default) The key of the cache entry to remove. If empty or null, all entries will be checked for removal. If this parameter is given, the param prefix is ignore.
prefix	string Removes all entries from the cache starting with given prefix. If param key is given, this param is ignored.

Responses

cache.get

Reads a value with given key from the cache and writes it into the output.

Search Academy for more details about: cache.get.

query Parameters

exit	boolean If true, exits the pipeline if cache entry exists.
key required	string (default) The key to load the value from the cache.
remove	boolean If true, removes the entry after it was successfully returned.

Responses

cache.has

Checks if cache has given entry

Search Academy for more details about: cache.has.

query Parameters

key	string (default) Checks, if cache has entry with given key. If yes, puts true in the output. Otherwise false.

Responses

cache.info

Returns information about the current state of the cache. Available for system and support users only.

Search Academy for more details about: cache.info.

query Parameters

key	string Returns the info for a given cache entry. If null or empty, the overall cache info is returned.

Responses

Responses

comment

comment.delete

Deletes a single comment.

Search Academy for more details about: comment.delete.

query Parameters

uuid

required

string

The uuid of the comment to delete.

Responses

comment.get

Returns a single comment.

Search Academy for more details about: comment.get.

query Parameters

uuid

required

string

The uuid of the comment to return.

Responses

comment.list

Lists all comments for a given property.

Search Academy for more details about: comment.list.

query Parameters

targetPath	string The path of the target property this comment is for. If both targetUuid and targetPath are given, targetPath will be ignored. This param will be ignored if there is a comment in the input.
targetUuid	string The uuid of the target property this comment is for. If both targetUuid and targetPath are given, targetPath will be ignored. This param will be ignored if there is a comment in the input.

Responses

comment.put

Creates or updates the given comment in the system.

Search Academy for more details about: comment.put.

query Parameters

author	string The initial author of the comment. If null or empty, currently logged-in user will be used. This param will be ignored if there is a comment in the input.
targetPath	string The path of the target property this comment is for. If both targetUuid and targetPath are given, targetPath will be ignored. This param will be ignored if there is a comment in the input.
targetUuid	string The uuid of the target property this comment is for. If both targetUuid and targetPath are given, targetPath will be ignored. This param will be ignored if there is a comment in the input.
text	string The text of the comment. This param will be ignore if there is a comment in the input.

Responses

config

config.find

Returns all admin config settings for a given group from the backend as a JSON in this format: {configKey:{value:someValue, canOverwrite:true|false}}. The attribute canOverwrite is only available if param includePermission is set.

Search Academy for more details about: config.find.

query Parameters

group	string The config group to select: Returns all configs of this group. If null or empty, all configs of all groups will be returned if user has permission to do so.
includePermission	string If true, additionally shows whether a currently logged-in user can write/change a configuration or not by adding the attribute canOverwrite:true\|false. to each config entry.
key	string The config key inside a given group. If key doesn't start with a group prefix (example: signature), the group must be given by group param. If prefix exists (example: email.signature), the group param will be ignored.

Responses

container

container.registry.delete

Deletes a container registry.

Search Academy for more details about: container.registry.delete.

query Parameters

credentials	string DEPRECATED. Use param secret instead.
url	string The url of the registry.

Responses

container.registry.list

Lists all container registries.

Search Academy for more details about: container.registry.list.

query Parameters

credentials

string

DEPRECATED. Use param secret instead.

Responses

container.registry.put

Adds a new container registry.

Search Academy for more details about: container.registry.put.

query Parameters

credentials	string DEPRECATED. Use param secret instead.
email	string The email for the registry.
password	string The password to access the registry.
url	string The url of the registry.
username	string The username to access the registry.

Responses

content

content.get

Deprecated. Use resolve command instead. Reads content from provided uri and puts the result back to body.

Search Academy for more details about: content.get.

query Parameters

uri

exclude required	string A PEL which will be executed on each iteration item. If the expression results in a true value, the item will be removed from the list. Additionally to the default PEL variables, the variable item (= current iteration item, default name) will be provided.
iterItemName	string The name of the iteration item value, provided for exclude

Responses

data.list.limit

Limits a given list of data to a specific size. Removes any item from the list those index is above given maxLength - 1.

Search Academy for more details about: data.list.limit.

query Parameters

maxLength

string

format

Returns the docs for the available PEL utils.

Search Academy for more details about: docs.pelutils.

Responses

docs.pipeforce.apidoc

Returns the OpenAPI documentation of all default PIPEFORCE hub API endpoints.

Search Academy for more details about: docs.pipeforce.apidoc.

Responses

docs.pipeline.schema

Returns the V7 compliant JSON schema for a pipeline and all built-in commands.

Search Academy for more details about: docs.pipeline.schema.

Responses

document

document.understand

Returns metadata for a given unstructured document like an invoice PDF for example. Expects the document to be in the body by default. Returns the result as JSON in the body (replacing any existing value in the body).

Search Academy for more details about: document.understand.

query Parameters

apiKey	string The alternative API key to connect to the service. If null or empty, the default one will be used, as defined by the default backend settings.
config	string The config json to process document
filter	string A PEL as filter to be applied to the output data before it is returned by this command. If null or empty, no filter is applied.
provider	string The name of the provider to process document.
restUrl	string The URL to be called by the command. If null or empty, the default url will be used as defined in the backend.
secret	string The name of the secret in secret store.

Responses

docusign

Requests a signature of the given document in the body
via email (remote signing) using DocuSign. See here:
https://developers.docusign.com/esign-rest-api/code-examples/code-example-request-a-signature-via-email
Expects the to be signed document in the body with json.file encoding.

Search Academy for more details about: docusign.

query Parameters

accessToken	string The DocuSign access token. If null or empty, the token will be read from settings.
accountId	string The docuSign account Id for REST calls. Can be obtained here: https://developers.docusign.com/esign-rest-api/guides/authentication/user-info-endpoints . If not set, the command tries to get the account ID by an additional request from DocuSign
ccEmail	string The email of cc user to get informed about the signing request. If null, no cc mail is sent.
ccName	string The name of cc email user to get informed about the signing request.
signerEmail required	string The email address of the signer.
signerName	string The real name of the signer.
subject	string The email subject to be send to the signer. If null or empty, the default subject will be set.

Responses

drive

drive.archive.save

Saves the content of the body to the given archive folder in Drive. The content of the body must be a single file. Verifies the integrity of the archive on write. Returns the final archive file name / path (without archive root path) into the output target.

Search Academy for more details about: drive.archive.save.

query Parameters

namingPattern

string

The PEL pattern to be applied to generate the final archive file name / path. This name / path will be relative to the given archive root path. Additionally, provides these variables in this PEL pattern context: archiveCounter = The last value used as counter as it comes from the .counter file. When not present, is initialized by counting all files in archive folder. counter = The archiveCounter increased by 1.archivePath = The path to the archive root as given by path param. basename = The base filename of the archive file, without extension (for example myfile.pdf = myfile). basenameNoId = Same as basename but without the _ID-123 part in the file name if there is any.ext = The extension of the archive file, without a period (for example myfile.pdf = pdf) filename = The full name of the archive file, with extension (for example myfile.pdf = myfile.pdf). The default pattern is this: basename_counter.ext

path

required

string

The root path of the archive folder where the file to be saved to.

Responses

drive.copy

Copies a folder or file on Drive.

Search Academy for more details about: drive.copy.

query Parameters

path required	string The path of the folder or file to be copied.
to required	string The target folder to copy the resource into.

expr

required

string

(default) The pipeline expression to be executed. Can be a single pel string or a list of expression strings.

Responses

event

event.listen

Deprecated. Use message.listen instead. Listening for events works like this: Add this command at the very first in your pipeline, define the event key you want to listen for and an optional filter expression. Then save this pipeline into the property store. This causes the system to automatically register this pipeline and execute it whenever an event with given key and matching filter is fired. Note: Only one event.listen command per pipeline is allowed and it needs to be the very first command in the pipeline. In the body of the pipeline the event object is provided and can be used for filtering for example.

Search Academy for more details about: event.listen.

query Parameters

eventKey	string The key to listen for.
filter	string DEPRECATED: Use parameter 'selector' instead. An optional PEL to execute the pipeline only in case the filter applies.
key	string Deprecated. Use eventKey instead.
selector	string Selects the message to be passed to this listener. Can be a PEL or a selector expression. Note: For performance reasons, using the body payload for filtering is not allowed here and will throw an exception. Use headers for filtering instead. If this parameter is set, filter will be ignored.

Responses

Responses

Responses

form

form.attachment.chunk.put

Adds a chunk to the given form draft attachment.
The chunk data is expected to be in the body (input) as binary stream or content object.

Search Academy for more details about: form.attachment.chunk.put.

query Parameters

collectionName	string The collection of attachment. If not specified, root attachment is expected.
content	string The content to be added to the chunk. If this parameter is null or empty, the body will be used as content instead.
formSessionId required	string The form session id.
name	string The name of the attachment this chunk belongs to.

Responses

form.attachment.content

Reads the content of a form draft attachment.

Search Academy for more details about: form.attachment.content.

query Parameters

collectionName	string The collection of attachment to add to. If not specified, root attachment is created.
formSessionId required	string The form session id.
name required	string The name of the attachment to be read.

Responses

form.attachment.delete

Removes an attachment from a form draft.

Search Academy for more details about: form.attachment.delete.

query Parameters

collectionName	string The collection of attachment to delete from. If not specified, root collection is considered.
formSessionId required	string The form session id.
name required	string The name of the attachment to be deleted.

Responses

form.attachment.list

Lists all attachment of a given form draft.

Search Academy for more details about: form.attachment.list.

query Parameters

collectionName	string The collection of attachments to list. If not specified, root attachments are listed.
formSessionId required	string The form session id.

Responses

form.attachment.put

Adds an uploaded file to the given form draft.
The file is expected to be in input as binary stream or content object.
In case input is null, an attachment of size 0 will be created.

Search Academy for more details about: form.attachment.put.

query Parameters

collectionName	string The collection of attachment to add to. If not specified, root attachment is created.
contentType	string The content type to be used for the attachment. If not set, the value from the content object from input will be used (if any). In case none can be found, application/octet-stream will be used.
fieldName	string The name of the field in the form data JSON this attachment belongs to.
formSessionId required	string The form session id.
length	string The length of the overall attachment. Length of content given in input (if any) must be equal to or smaller than this value.
name	string The file name of the attachment to be created. If an attachment with this name already exists, overwrites the existing one. If this param is not given, the value from the content object from input will be used (if any).

Responses

form.cleanup

Does a cleanup check and deletes all outdated form sessions. This command is mainly for testing and admin purposes. Not for business pipelines.

Search Academy for more details about: form.cleanup.

query Parameters

checkTtl	boolean Checks the ttl of all form sessions and related data. Corrects it if required.
deleteOldest	number Deletes the given number of oldest form sessions.

Responses

form.start

Returns the form config with input and schema paths resolved.

Search Academy for more details about: form.start.

query Parameters

formId	string The form id. Typically used in public forms where the form config path may not be shown for security reasons.
formParameters	string The optional parameters to the form config. For example if a URI in a form config contains parameters.
formPath	string The property path of the form config. If both, formId and formPath are given, formPath will be ignored.
formSessionId required	string The form session id.

Responses

form.submit

Submits the given form session.
In case it contains submit data in body (input), this will become the final form data
to be send to output.

Search Academy for more details about: form.submit.

query Parameters

formSessionId

required

string

The form session id.

Responses

function

function.backend.cache.clear

Clears the cache of the FaaS backend.

Search Academy for more details about: function.backend.cache.clear.

Responses

query Parameters

args	string The arguments to be passed to the function. Must be serializable to JSON. Can also be a custom uri starting with $uri: pointing to a document which is a JSON document or can be converted to a JSON.
evalArgs	string Search the args param value recursively for PEL expressions and parse them?
name required	string (default) The name of the function to run.

Responses

gateway

gateway.endpoint.delete

Deletes an endpoint configuration.

Search Academy for more details about: gateway.endpoint.delete.

query Parameters

uuid

required

string

The uuid of the endpoint to delete.

Responses

gateway.endpoint.get

Returns an endpoint configuration.

Search Academy for more details about: gateway.endpoint.get.

query Parameters

uuid

required

string

The uuid of the endpoint to return.

Responses

gateway.endpoint.list

Lists all existing endpoint configurations.

Search Academy for more details about: gateway.endpoint.list.

Responses

gateway.endpoint.put

Adds a new endpoint configuration. Expects the config as JSON in the input. In case no uuid is given, a new entry is created.

Search Academy for more details about: gateway.endpoint.put.

query Parameters

authenticate	string Is authentication needed for this endpoint? In this case, the Authorization header must exist and must contain a valid authentication token or credentials. This will overwrite the value of the input JSON if there is any.
enabled	string Enables or disables this endpoint temporarily. This will overwrite the value of the input JSON if there is any.
groups	string The authenticated user must be member to at least one of the groups from this list. If null or empty, no authorization check is done after successful authentication. Authentication is mandatory to be enabled for this. This will overwrite the value of the input JSON if there is any.
methods	string A list of HTTP methods to allow. If this list contains *, all methods are allowed. This will overwrite the value of the input JSON if there is any.
mocked	string If given, mocks this endpoint for testing (= doesn't forward to real endpoint). This will overwrite the value of the input JSON if there is any.
pattern required	string The wildcard pattern, the incoming request path must match in order to get called. This will overwrite the value of the input JSON if there is any.
polling	string In case this endpoints is an async target, should a polling redirect be applied to the request so it polls for the result until has been processed or timed out?
roles	string The authenticated user must be assigned to at least one of the roles from this list. If null or empty, no authorization check is done after successful authentication. Authentication is mandatory to be enabled for this. This will overwrite the value of the input JSON if there is any.
target required	string The target uri to be executed in case the request matches. This will overwrite the value of the input JSON if there is any.
uuid	string The uuid of the endpoint to update. This will overwrite the value of the input JSON if there is any or create a new entry if missing.
weight	string The weighting of this entry. In case a path matches two entries, the one with higher wight value will win.

Responses

gateway.group.list

Lists all groups allowed to be assigned to endpoints.

Search Academy for more details about: gateway.group.list.

Responses

gateway.role.list

Lists all roles allowed to be assigned to endpoints.

Search Academy for more details about: gateway.role.list.

Responses

global

global.config.property.list

Returns all global config properties.

Search Academy for more details about: global.config.property.list.

query Parameters

scope

string

key required	string The config key those value to save.
scope	string The scope of the config entry.
value required	string The config value to save.

Responses

header

header.set

DEPRECATED. Use the set command instead. Sets any parameter value as header. For example header.set?key1=value1&key2=value2 would become the headers: key1: value1 and key2: value2

Search Academy for more details about: header.set.

Responses

htmlunit

htmlunit.website.form.find

Searches for a form on the page and sets is as vars.form model in PEL. If param 'select' is given, uses this PEL to find the form object. Otherwise tries to detect the form automatically by searching the page and using the first form found. Note: The pipe is BETA and not intended to be used in production!

Search Academy for more details about: htmlunit.website.form.find.

query Parameters

select

string

A PE to select elements on a website for subsequent RPA commands. If null, form is tried to select automatically.

Responses

htmlunit.website.form.input

Searches for an input element with given name and sets the given value on it. Note: The pipe is BETA and not intended to be used in production!

Search Academy for more details about: htmlunit.website.form.input.

query Parameters

select	string A PE to select elements on a website for subsequent RPA commands. If null, form is tried to select automatically.
value	string The value to be set on the selected input field.

The url of the web page to open.

Responses

htmlunit.website.scrap

Scraps data from the current website and returns the result in the body.Note: The pipe is BETA and not intended to be used in production!

Search Academy for more details about: htmlunit.website.scrap.

query Parameters

select	string A PE to select elements on a website for subsequent RPA commands. If null, form is tried to select automatically.
xpath required	string Executes the given xpath expression on the current page and puts the result in the body. In case the xpath returns more than one results, adds an array to the body. Otherwise the body only contains the single result value.

Responses

http

http.delete

Executes a DELETE HTTP call to the given url.Returns the result from the server in the message body.

Search Academy for more details about: http.delete.

query Parameters

body	string The value to be set in the body of the request (if it supports a body). If this param is missing, the value from the input parameter is used. If this value is null, no body is used.
credentials	string DEPRECATED. Use param secret instead.
forceContentType	string If this parameter is set to null or empty, the responsethe body from the response is returned in the same format as it is defined by the HTTP response Content-Type header. This can be overwritten by setting an explicit Content-Type here. When set, it will be tried to convert the response body to this content-type first and return it as this type then.
headers	string A list of headers to append to the request. Can be a PEL pointing to a map or a list of name-value pair strings name:value or a comma separated string like: name1:value1, name2:value2.
ignoreErrorStatus	string If true, any error status code from response will be ignored and no exception will be thrown. Otherwise, an exception will be thrown in case the request returns with status code >= 400.
includeRequest	string If true, includes the HTTP request as JSON in the output.
includeResponse	string If true, writes the HTTP response including headers and status code as JSON in the output.
passthru	string If true, the response will be passed 1:1 to the caller of the pipeline without any changes. Status errors wont be handled and also no auto-conversion of body data will be applied. Note: It is not intended to alter the response in any kind when in passThru-mode.
secret	string Refers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.
service	string The name of the internal service to be called. If this parameter is given, it will prefix the url parameter, if exists. This parameter can also contain the internal port information separated by a colon like serviceName:port. If no port is given, it will be looked-up automatically.
url	string (default) The url for the HTTP call.

Responses

http.get

Executes a GET HTTP call to the given url.Returns the result from the server in the message body or wrapped in the response JSON format depending on its configuration.

Search Academy for more details about: http.get.

query Parameters

body	string The value to be set in the body of the request (if it supports a body). If this param is missing, the value from the input parameter is used. If this value is null, no body is used.
credentials	string DEPRECATED. Use param secret instead.
forceContentType	string If this parameter is set to null or empty, the responsethe body from the response is returned in the same format as it is defined by the HTTP response Content-Type header. This can be overwritten by setting an explicit Content-Type here. When set, it will be tried to convert the response body to this content-type first and return it as this type then.
headers	string A list of headers to append to the request. Can be a PEL pointing to a map or a list of name-value pair strings name:value or a comma separated string like: name1:value1, name2:value2.
ignoreErrorStatus	string If true, any error status code from response will be ignored and no exception will be thrown. Otherwise, an exception will be thrown in case the request returns with status code >= 400.
includeRequest	string If true, includes the HTTP request as JSON in the output.
includeResponse	string If true, writes the HTTP response including headers and status code as JSON in the output.
passthru	string If true, the response will be passed 1:1 to the caller of the pipeline without any changes. Status errors wont be handled and also no auto-conversion of body data will be applied. Note: It is not intended to alter the response in any kind when in passThru-mode.
secret	string Refers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.
service	string The name of the internal service to be called. If this parameter is given, it will prefix the url parameter, if exists. This parameter can also contain the internal port information separated by a colon like serviceName:port. If no port is given, it will be looked-up automatically.
url	string (default) The url for the HTTP call.

Responses

http.patch

Executes a PATCH HTTP call to the given url.Returns the result from the server in the message body.

Search Academy for more details about: http.patch.

query Parameters

body	string The value to be set in the body of the request (if it supports a body). If this param is missing, the value from the input parameter is used. If this value is null, no body is used.
credentials	string DEPRECATED. Use param secret instead.
forceContentType	string If this parameter is set to null or empty, the responsethe body from the response is returned in the same format as it is defined by the HTTP response Content-Type header. This can be overwritten by setting an explicit Content-Type here. When set, it will be tried to convert the response body to this content-type first and return it as this type then.
headers	string A list of headers to append to the request. Can be a PEL pointing to a map or a list of name-value pair strings name:value or a comma separated string like: name1:value1, name2:value2.
ignoreErrorStatus	string If true, any error status code from response will be ignored and no exception will be thrown. Otherwise, an exception will be thrown in case the request returns with status code >= 400.
includeRequest	string If true, includes the HTTP request as JSON in the output.
includeResponse	string If true, writes the HTTP response including headers and status code as JSON in the output.
passthru	string If true, the response will be passed 1:1 to the caller of the pipeline without any changes. Status errors wont be handled and also no auto-conversion of body data will be applied. Note: It is not intended to alter the response in any kind when in passThru-mode.
secret	string Refers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.
service	string The name of the internal service to be called. If this parameter is given, it will prefix the url parameter, if exists. This parameter can also contain the internal port information separated by a colon like serviceName:port. If no port is given, it will be looked-up automatically.
url	string (default) The url for the HTTP call.

Responses

http.post

Executes a POST HTTP call to the given url.Returns the result from the server in the message body.

Search Academy for more details about: http.post.

query Parameters

body	string The value to be set in the body of the request (if it supports a body). If this param is missing, the value from the input parameter is used. If this value is null, no body is used.
credentials	string DEPRECATED. Use param secret instead.
forceContentType	string If this parameter is set to null or empty, the responsethe body from the response is returned in the same format as it is defined by the HTTP response Content-Type header. This can be overwritten by setting an explicit Content-Type here. When set, it will be tried to convert the response body to this content-type first and return it as this type then.
headers	string A list of headers to append to the request. Can be a PEL pointing to a map or a list of name-value pair strings name:value or a comma separated string like: name1:value1, name2:value2.
ignoreErrorStatus	string If true, any error status code from response will be ignored and no exception will be thrown. Otherwise, an exception will be thrown in case the request returns with status code >= 400.
includeRequest	string If true, includes the HTTP request as JSON in the output.
includeResponse	string If true, writes the HTTP response including headers and status code as JSON in the output.
passthru	string If true, the response will be passed 1:1 to the caller of the pipeline without any changes. Status errors wont be handled and also no auto-conversion of body data will be applied. Note: It is not intended to alter the response in any kind when in passThru-mode.
secret	string Refers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.
service	string The name of the internal service to be called. If this parameter is given, it will prefix the url parameter, if exists. This parameter can also contain the internal port information separated by a colon like serviceName:port. If no port is given, it will be looked-up automatically.
url	string (default) The url for the HTTP call.

Responses

http.put

Executes a PUT HTTP call to the given url.Returns the result from the server in the message body.

Search Academy for more details about: http.put.

query Parameters

body	string The value to be set in the body of the request (if it supports a body). If this param is missing, the value from the input parameter is used. If this value is null, no body is used.
credentials	string DEPRECATED. Use param secret instead.
forceContentType	string If this parameter is set to null or empty, the responsethe body from the response is returned in the same format as it is defined by the HTTP response Content-Type header. This can be overwritten by setting an explicit Content-Type here. When set, it will be tried to convert the response body to this content-type first and return it as this type then.
headers	string A list of headers to append to the request. Can be a PEL pointing to a map or a list of name-value pair strings name:value or a comma separated string like: name1:value1, name2:value2.
ignoreErrorStatus	string If true, any error status code from response will be ignored and no exception will be thrown. Otherwise, an exception will be thrown in case the request returns with status code >= 400.
includeRequest	string If true, includes the HTTP request as JSON in the output.
includeResponse	string If true, writes the HTTP response including headers and status code as JSON in the output.
passthru	string If true, the response will be passed 1:1 to the caller of the pipeline without any changes. Status errors wont be handled and also no auto-conversion of body data will be applied. Note: It is not intended to alter the response in any kind when in passThru-mode.
secret	string Refers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.
service	string The name of the internal service to be called. If this parameter is given, it will prefix the url parameter, if exists. This parameter can also contain the internal port information separated by a colon like serviceName:port. If no port is given, it will be looked-up automatically.
url	string (default) The url for the HTTP call.

Responses

http.response.set

Prepares the HTTP response in case this pipeline is executed in an HTTP request context. In case the pipeline is not running inside an HTTP request context, nothing happens in executing this command. Note: In case the pipeline was initiated by an HTTP request, you can access the request headers using the headers scope: headers.request.

Search Academy for more details about: http.response.set.

query Parameters

headers	string The HTTP headers to be add as JSON or name-value pairs.
statusCode	string The HTTP status code to be set on the HTTP response.

Responses

i18n

i18n.messages

Returns the i18n messages of given app, context and locale.

Search Academy for more details about: i18n.messages.

query Parameters

app	string The app which contains the i18n messages.
context	string The context of the i18n messages.
locale	string The locale of the i18n message. For example: en, de, fr and so on.

Responses

iam

iam.apitoken

Obtains the apitoken (= offline token) in exchange for user credentials provided and writes it into the output.

Search Academy for more details about: iam.apitoken.

query Parameters

password required	string The user password.
username required	string The user name.

Responses

Responses

iam.role.add.composites

Adds existing composite roles to an existing role.

Search Academy for more details about: iam.role.add.composites.

query Parameters

composites required	string The composite role names to join. Can be a comma separated list or a PEL pointing to a list.
roleName required	string The unique role name to be loaded.

Responses

iam.role.members

Lists all users which are member of the given role. The response is a JSON array with these entities: https://www.keycloak.org/docs-api/5.0/rest-api/index.html#_userrepresentation

Search Academy for more details about: iam.role.members.

query Parameters

filter	string The filter query to additionally filter the result. Not applied if null
max	number The max number of entries to return. If set to a higher value than 100, will be reset to 100.
offset	number The offset to start return entries.
roleName	string The name of the role.

Responses

iam.role.put

Creates a new role and puts its role uuid in the body under key roleUuid. Throws exception if role already exists.

Search Academy for more details about: iam.role.put.

query Parameters

attributes	string A map which holds optional attributes to be added to this role.
composites	string A PEL list of roles names to add to this role as children. Makes this role a composite.
name required	string The unique role name.

Responses

iam.run.as

Executes the subsequent pipeline as different user if following two conditions are met. 1. currently logged-in user has permission CAN_RUN_AS_SOURCE 2. requested user has permission CAN_RUN_AS_TARGET

Search Academy for more details about: iam.run.as.

query Parameters

caching	string Should the IAM cache used (= much faster)?
username required	string (default) The username, subsequent commands must be executed as. This user must have RUN_AS_SOURCE role assigned.

Responses

iam.search

Searches for specific entity in the IAM service matching the given filter. Returns the JSON representation of the given type as JSON array. See here for the representation types: https://www.keycloak.org/docs-api/11.0/rest-api/ .For example the type 'USER' would return a list of 'UserRepresentation'.

Search Academy for more details about: iam.search.

query Parameters

filter	string The filter query to additionally filter the result. Not applied if null
max	number The max number of entries to return. If set to a higher value than 100, will be reset to 100.
offset	number The offset to start return entries.
type required	string The entity type to search for. Supported values are: ROLE, USER, GROUP, REALM.

Responses

iam.token

Obtains the full offline token response JSON in exchange for user credentials provided and writes into the output.

Search Academy for more details about: iam.token.

query Parameters

password required	string The user password.
username required	string The user name.

Responses

iam.token.logout

Logs out keycloak session associated with refreshToken and removes any refresh and access tokens from headers.

Search Academy for more details about: iam.token.logout.

query Parameters

refreshToken

required

string

The refresh token.

Responses

iam.token.refresh

Enrich headers with accessToken obtained from authorization server using refreshToken and returns the tokenResponse in the body.

Search Academy for more details about: iam.token.refresh.

query Parameters

refreshToken

required

string

if.end

Defines the end of an 'if' command.

Search Academy for more details about: if.end.

Responses

imap

imap.delete

Deletes the selected mails by the given filter parameters, e.g. delete mails for the filters unreadOnly, folder, sender.

Search Academy for more details about: imap.delete.

query Parameters

folder	string Optional filter parameter, Folder from where we want to delete the mails. Default value is INBOX.
from	string Optional filter parameter, filter mails by provided sender.
host required	string Host for the mailbox. E.g. outlook.office365.com
secret required	string Secret, which contains the imap credentials and config json.
subjectContains	string Limit to emails containing this text in subject.
unreadOnly	boolean Limit to emails with this unread flag. If missing, no read filter will be applied.

Responses

imap.get

Searches the mails and returns all the mails retrieved using the given criteria.

Search Academy for more details about: imap.get.

query Parameters

folder	string Optional filter parameter, search mails from particular given folder. Default value will be INBOX.
from	string Optional filter parameter, filter mails by provided sender.
host required	string Host for the mailbox. E.g. outlook.office365.com
markSeen	boolean Mark returned emails as seen (read)?
secret required	string Secret, which contains the imap credentials and config json.
subjectContains	string Limit to emails containing this text in subject.
unreadOnly	boolean Limit to emails with this unread flag. If missing, no read filter will be applied.

Responses

imap.mkdir

Creates the folder as a sibling of INBOX or inside INBOX or any other folder and returns the status.

Search Academy for more details about: imap.mkdir.

query Parameters

destinationFolder	string Optional filter parameter, creates a folder inside the given folder. Default value is INBOX.
folderName required	string Folder name to create a folder inside a destination folder.
host required	string Host for the mailbox. E.g. outlook.office365.com
secret required	string Secret, which contains the imap credentials and config json.

Responses

imap.move

Moves the selected mails by the given filter parameters to the provided mailbox folder.

Search Academy for more details about: imap.move.

query Parameters

destinationFolder required	string Targeted folder for the mails to move.
from	string Optional filter parameter, filter mails by provided sender.
host required	string Host for the mailbox. E.g. outlook.office365.com
secret required	string Secret, which contains the imap credentials and config json.
sourceFolder	string Optional filter parameter, Source folder from where we want to move the mails. Default value is INBOX.
subjectContains	string Limit to emails containing this text in subject.
unreadOnly	boolean Limit to emails with this unread flag. If missing, no read filter will be applied.

Responses

job

Schedules any subsequent commands of the current pipeline and executes it at the scheduled times.

Search Academy for more details about: job.

query Parameters

schedule required	string A schedule string which configures the execution of the job. Can be one of: EVERY_5_MIN, EVERY_15_MIN, EVERY_30_MIN, EVERY_45_MIN, HOURLY, DAILY, WEEKLY, MONTHLY. Furthermore in development stage also EVERY_1_MIN is allowed. Throws an exception in production stage.
stop	string Deprecated. Use the command job.stop instead. If this param is set, all other params are ignored. It contains the id of the job to be canceled.

Responses

job.list

Lists all scheduled pipeline jobs.

Search Academy for more details about: job.list.

Responses

job.status

Returns the status of a given job or null in case the job doesnt exist.

Search Academy for more details about: job.status.

query Parameters

pipelineKey

required

string

The pipelineKey of the job those status to return

Responses

job.stop

Stops the job with given id. Note: Usually it is not required to use this command. In order to stop and unregister a job, simply remove it from the pipeline or delete the pipeline.

Search Academy for more details about: job.stop.

query Parameters

pipelineKey

required

string

The pipeline key of the job to be cancelled.

Responses

jpa

jpa.query

Executes a JPA query and returns the result as JSON in the body. NOTE: This pipe is primarily meant for support to monitor the system. Its not accessible by default accounts! This can change at any time without notice!

Search Academy for more details about: jpa.query.

query Parameters

query

string

The JPA query to be executed.

Responses

json

json.validate

Validates the syntax of the JSON document given in the body or the input parameter. Can additionally validate the JSON using the given JSON schema. See https://json-schema.org/.

Search Academy for more details about: json.validate.

query Parameters

schema	string The JSON schema to be used for schema validation. Can be a string, a PEL or a custom uri pointing to the location of the schema. In case no schema is defined, only a JSON syntax validation is performed.
throwException	string If 'true', an exception is thrown in case of an syntax or schema validation error and the pipeline execution will be stopped. If set to 'false', the validation result will be returned as JSON in the output having the fields 'status' and 'message' whereas 'status' can be one of 'error' or 'ok'. In case of an validation error, all validation errors will be put into the 'message' field.
version	string The version of the schema specification to be used.

Responses

log

Logs the given input message without changing it.

Search Academy for more details about: log.

query Parameters

level	string The log level. Can be one of DEBUG, TRACE, INFO, WARN, ERROR. If null or empty, INFO will be used.
message required	string (default) The message to log. Can be a string or a pipeline expression. If null or empty, the current pipeline message will be logged.
suffix	string Suffix log message with path of persisted pipeline path if any. This simplifies searching in logs later.

Responses

log.list

Returns the given number of log lines from specified service.

Search Academy for more details about: log.list.

query Parameters

format	string The format to be returned. One of: text, json
lines	number The number of lines to print in case format is text. 100 is printed when not specified.
service	string The service to print logs for. If null or empty, the 'hub' will be used.

Responses

log.list.email

Returns the email audit log properties. Only available for developers, system or support users.

Search Academy for more details about: log.list.email.

query Parameters

auditId	string The audit id (uuid) of the logged email to return. If null or empty, all emails will be returned matching the given parameters.
createdAfter	string Returns only those emails created after this date in ISO-8601 format. If null or empty, no after filter will be set.
createdBefore	string Returns only those emails created before this date in ISO-8601 format. If null or empty, no before filter will be set.

Responses

log.list.environment

Logs the current environment properties. Only available for developers, system or support users.

Search Academy for more details about: log.list.environment.

query Parameters

interpolate

string

Return all properties with values interpolated? (= ${some.var} is resolved).

Responses

log.search

Searches the cloud logs and returns the last 30 entries per request. Supports pagination toscroll thru the entries. Does not return log.search log entries in order to not repeat itself.

Search Academy for more details about: log.search.

query Parameters

endDateTime	string An ISO8601 date-time string to end the search at. If null or empty, all results up to now will be returned.
messageFilter	string Message search string to filter the result by matching this string. Can be null or empty to return any entry.
nextPageToken	string If this value is given, the next page of results of a previous search is loaded.
service	string The service to search for log entries. Can be a list or comma separated service names. If null or empty, 'hub' will be used as default.
severity	string The severity to search inside: DEBUG, INFO, WARNING, ERROR. Can be a list or comma separated text. If null or empty, searches in all severities.
startDateTime	string An ISO8601 date-time string to start the search at. If null or empty, the date-time string from 24h before will be used.
typeFilter	string A list of types of message logs to show. Possible values are: command, pipeline, security_audit, event_fired, webhook. If not set, all logs will be shown.

Responses

log.services

Returns all PIPEFORCE services for those logging is allowed / enabled.

Search Academy for more details about: log.services.

Responses

log.severities

Returns all severities (for example, DEBUG, INFO,...), supported by the logging system.

Search Academy for more details about: log.severities.

Responses

macro

Defines a custom macro inside a pipeline. Such a macro can then be re-used by calling the command 'macro.run'.

Search Academy for more details about: macro.

query Parameters

args	string The args to the macro as name-value pairs. If this macro will be re-called, these args will be default args which can be overwritten by the caller.
do	string (default) The macro body to be executed as PEL.
flow	string If set to true, the macro will be called by the pipeline flow even if 'name' parameter is set.
name	string The optional name of the macro. If given, the macro will be registered under this name an can be re-called using the command 'macro.run'.

Responses

macro.run

Calls a defined macro by its name.

Search Academy for more details about: macro.run.

query Parameters

args	string The optional args to the macro as name-value pairs.
name	string (default) The name of the macro to call.

Responses

mail

mail.dump

Fetches new emails from given mail inbox and uploads them into a drive folder. Note: This command is for demo purposes only and not intended for production use.

Search Academy for more details about: mail.dump.

query Parameters

drivePassword required	string The password of the drive account to upload to.
driveUsername required	string The username of the drive account to upload to.
host required	string The email host.
inboxPassword required	string The password of the email inbox.
inboxUsername required	string The username of the email inbox.
path	string The remote folder path in drive where to upload the emails into. For each new email a new sub folder will be created inside this path. If null or empty, uploads to the root folder of the logged in user.
port required	number The port of the email host.
protocol	string The email protocol. One of 'imap' or 'pop3'.

Responses

mail.fetch

Fetches new emails from given mail inbox and returns them as JSON in the output. Note: This command is for demo purposes only and not intended for production use.

Search Academy for more details about: mail.fetch.

query Parameters

host required	string The email host.
inboxPassword required	string The password of the email inbox.
inboxUsername required	string The username of the email inbox.
newMailsOnly	string Download only new mails since last processing? If true, the state of last fetch will be kept in property store. Any new fetch will be checked with this state and email will be downloaded only if not processed yet.
port required	number The port of the email host.
protocol	string The email protocol. One of 'imap' or 'pop3'.

Responses

mail.send

Sends the given message as email. The message's subject and body will be used in the email accordingly.

Search Academy for more details about: mail.send.

query Parameters

attachments	string Can be a comma separated list of URI Strings (e.g.: uri:drive:file1, uri:property:global/file2, uri:drive:file1, uri:classpath:pipeforce/file3). Also can point via PEL to a content object or a content collection. If the PEL points to an object differently to an uri or content object, serializes the value to string and attaches this as a text file.
from	string The from email.
fromName	string The from name.
message	string By default, the body is used as email message. If this param is set, it will be used as message instead. Can also be a PE which points to a value to be used as the mail message.
model	string The model to be placed into the template scope. If null, the message is used as model so you can access vars and body the same way as you would do in the pipeline.
replyTo	string Reply-To email address is used when email receiver uses its mail client's 'reply' function. If not used,the from address is used automatically.
subject	string The subject.
to required	string Comma separated list of to email addresses. Never null. If this is an expression and points to comma separated list, an array or a collection, will send an email to any of the entries.

Responses

mail.verify

Protects any subsequent pipe commands: Pipeline is only executed
in case the caller has verified that he is the owner of given
email address. To do so, a magic link (verification link) is sent
to his email account. Only if the user clicks on this link within
a certain amount of time (default is 10min), the subsequent pipe
commands are executed. From a technical point of view this is done
by putting the current state of the message into a cache which deletes
any entries older than 10min. Then, the email with the key to this
cache entry (=challenge) is send to the user. If the user clicks on
this link, the message is loaded from the cache using the challenge as
the key. If the user clicked within 10min, the entry is here, can be
loaded and the message execution can be resumed. Otherwise if the user
clicks after 10min on the link, no more entry in it. Execution fails.
User has to re-request the link. Note: This command is for demo purposes only and not intended for production use.

Search Academy for more details about: mail.verify.

query Parameters

challenge	string The challenge which will become part of the link in the email when redirecting back.
email required	string The email address to send the challenge to.
email.blacklist	string A comma separated list of blocked email addresses. Also supports wildcards . Example: @domain.com, my@email.com
email.whitelist	string A comma separated list of allowed email addresses. Also supports wildcards . Example: @domain.com, my@email.com

Responses

map

DEPRECATED. Use the set command instead. Maps, calculates and converts data from fields of the input message to fields of the output message.

Search Academy for more details about: map.

query Parameters

reverse

Deletes a binding.

Search Academy for more details about: message.binding.delete.

query Parameters

args	string Custom args to be passed to the binding to remove.
destinationName required	string The name of the destination of the binding to remove.
destinationType	string The type of the destination of the binding to remove. One of queue or exchange.
exchange	string The exchange involved in this binding to remove.
routingKey	string The routing key to be used for the binding to remove.

Responses

message.binding.put

Creates a new binding. Returns the binding info as JSON.

Search Academy for more details about: message.binding.put.

query Parameters

args	string Custom args to be passed to the binding creation.
destinationName required	string The name of the destination of the binding.
destinationType	string The type of the destination of the binding. One of queue or exchange.
exchange	string The exchange involved in this binding.
routingKey required	string The routing key to be used for the binding

Responses

message.drop

Drops message without redelivery for pipeline initiated by message.receive with autoack=false.

Search Academy for more details about: message.drop.

Responses

message.exchange.delete

Deletes an exchange.

Search Academy for more details about: message.exchange.delete.

query Parameters

name

required

string

message.queue.delete

Deletes a queue.

Search Academy for more details about: message.queue.delete.

query Parameters

empty	string Delete only if empty?
name required	string The name of the queue to delete.
unused	string Delete only if not is use?

Responses

message.queue.find

Returns details for all message queues matching the given search filter.

Search Academy for more details about: message.queue.find.

query Parameters

includeBindings

string

Include the bindings for each queue?

Responses

message.queue.get

Returns details about a message queue.

Search Academy for more details about: message.queue.get.

query Parameters

name

required

string

contentType	string Sets the content type of the message payload.
encoding	string The encoding of the message payload.
evalPayload	string Search the payload param value recursively for PEL expressions and parse them?
exchange	string The exchange to be used. If null, the default exchange will be used.
headers	string The headers to be send with the message. Values in here will overwrite any already existing header values.
key required	string The routing key to send the message as.
payload	string The payload to be send in the message. If parameter is missing, the message body will be used as payload.

Responses

microsoft

microsoft.graph.client

Provides a client to simplify access to MS Graph API. (BETA!)
See: https://learn.microsoft.com/en-us/graph/api/overview?view=graph-rest-1.0
Also see:
https://javadoc.io/static/com.microsoft.graph/microsoft-graph/5.42.0/com/microsoft/graph/requests/GraphServiceClient.html

Search Academy for more details about: microsoft.graph.client.

query Parameters

expression	string The expression to apply to the graph API client. Also see: https://javadoc.io/static/com.microsoft.graph/microsoft-graph/5.42.0/com/microsoft/graph/requests/GraphServiceClient.html
secret	string The secret to be used to access the endpoint.

Responses

microsoft.sharepoint.document.get

To download file from sharepoint.

Search Academy for more details about: microsoft.sharepoint.document.get.

query Parameters

hostName	string Host name of the sharepoint site
path	string This path contains the folder path in sharepoint site where user want to upload file
secret	string This is the name of secret that has been setup in Secret module (the secret must contain client_id, client_secret)
site	string This is the name of site in sharepoint where user want to upload file in the site folder.
tenantId	string Tenant Id of the sharepoint site

Responses

microsoft.sharepoint.document.mkdir

To create folder in Sharepoint.

Search Academy for more details about: microsoft.sharepoint.document.mkdir.

query Parameters

hostName	string Host of the sharepoint site
path	string This path contains the folder path in sharepoint site where user want to upload file
secret	string This is the name of secret that has been setup in Secret module (the secret must contain client_id, client_secret)
site	string This is the name of site in sharepoint where user want to upload file in the site folder.
tenantId	string Tenant Id of the sharepoint site

Responses

microsoft.sharepoint.document.put

To upload file to sharepoint.

Search Academy for more details about: microsoft.sharepoint.document.put.

query Parameters

hostName	string Host of the sharepoint site
path	string This path contains the folder path in sharepoint site where user want to upload file
secret	string This is the name of secret that has been setup in Secret module (the secret must contain client_id, client_secret)
site	string This is the name of site in sharepoint where user want to upload file in the site folder.
tenantId	string Tenant Id of the sharepoint site

Responses

microsoft.teams.send

Sends a message to a Microsoft Teams channel.
"Note: This command needs an additional license + secret setup.
"See documentation for further details how to set this up.

Search Academy for more details about: microsoft.teams.send.

query Parameters

channelId required	string The id of the teams channel to send the message to.
secret	string The secret to be used to authenticate in Microsoft 365 Cloud. If not set, the default secret will be used: DEFAULT_MICROSOFT_365_SECRET
teamId required	string The id of the team to send the message to.
text required	string The text message to be send to Teams.

Responses

mock

Creates and registers a mock for a command or pipeline.

Search Academy for more details about: mock.

query Parameters

command required	string The name of the command to mock
contextId	string The id of the mock context this mock is part of. If null or empty, the mock is not assigned to a context. If param is missing or is set to CURRENT: The current mock context id will be extracted from the header: mock_context_id. If there is no such id in header, a new one will be created and set.
namespace	string The namespace this mock is enabled for. If null, empty or CURRENT: Current namespace will be assigned.
pipeline	string The pipeline path this mock is enabled for. After the pipeline execution was finished, this mock will be deleted. If null or empty or param is missing, no pipeline will be assigned. If CURRENT: The current pipeline will be set in case it is a persisted one.
requestId	string The request id this mock is enabled for. If null or empty, the mock is not assigned to a requestId. After the request is finished, this mock will be deleted. If param is missing or is set to CURRENT: The current request id will be set.
thenSetBody	string The value to be returned in the body when this mock applies. If not defined, the current body will not be changed.
thenSetVar	string Defines a map which will be set as vars.
traceId	string The traceId this mock is enabled for. If null or empty, no traceId will be assigned. If CURRENT: The current traceId will be set.
when	string The mock expression: When this evaluates to true, the mock will be applied.

Responses

mock.cleanup

Removes all mocks from the mock service matching the given criteria.

Search Academy for more details about: mock.cleanup.

query Parameters

command	string Includes all mocks assigned to this command. If null, filter is not active.
lastAccessBefore	string Includes all mocks for deletion accessed before this timestamp in ms. If null, filter is not active.
mockContextId	string Includes all mocks assigned to the current mock context id. If null or false, filter is not active.
namespace	string Includes all mocks assigned to this namespace. If null, current namespace is used.
pipeline	string Includes all mocks assigned to this pipeline path, If null, filter is not active.
requestId	string Includes all mocks assigned to the given request id. If null or false, filter is not active.
traceId	string Includes all mocks assigned to this traceId If null, current trace id is used.

Responses

monitor

Returns actuator monitoring details.

Search Academy for more details about: monitor.

query Parameters

endpoint

string

(default) The endpoint path to return metrics for. If null or empty, the root will be returned: All endpoints will be listed.

Responses

monitor.alert.send

Sends and logs a technical alert to the support team.
Note: Alerts are only meant to target the AE and support / operations team in case
something technically critically happened (for example: Message queue full) in the instance or inside an app.
If you need to send business related alerts (example: The invoice is overdue) to business users,
consider to use notifications instead.
Since alert messages are sent to logs and other queues they must be short.

Search Academy for more details about: monitor.alert.send.

query Parameters

component	string The component this alert belongs to. If not set, then APP/{{appName}} will be used whereas appName will be extracted from current pipeline path. If this is not called from within a persisted pipeline and this param is not given = error. Must not be longer than 50 characters. Will be stripped otherwise.
message required	string The alert message to be sent. Must not be longer than 150 characters. Will be stripped otherwise.
monitorName required	string The name of the alert monitor check to identify and classify what was checked. Must not be longer than 50 characters. Will be stripped otherwise.

Responses

notification

notification.send

Creates and puts a mime notification to the queue for further processing and sending.
You can create a mime notification as JSON from scratch and set it as input param
(see public docs about the mime format required) or you can use the params of this command
to construct such a mime notification using these values. In case both are
given (params and input JSON), params will have precedence.

Search Academy for more details about: notification.send.

query Parameters

attachments	string A list of PIPEFORCE URI strings (e.g.: $uri:drive:file1, $uri:property:global/file2, $uri:drive:file1, $uri:attachment:123) to attach to the notification in case the notification target channel supports attachments. In case the
bcc required	string A list of to recipient CC addresses in case target channel supports BCC.
cc required	string A list of to recipient CC addresses in case target channel supports CC.
fromAddress	string The optional from address target channel supports this.
fromName	string The optional from name in case target channel supports this.
headers	string Key-value pairs to be set as headers in the mime message. These headers will overwrite any already existing one.
message	string The message to be send to the target channel.
replyTo	string Reply-To address is used when a recipient uses its client's reply function (for example inside an email client). In case this param is not given, the fromAddress is used as default.
subject	string The optional subject in case target channel supports this.
to required	string A list of to recipient TO addresses.

Responses

pdf

pdf.create

Creates a new PDF with blank pages.

Search Academy for more details about: pdf.create.

query Parameters

format	string The format of the pages to create. One of: A0, A1, A2, A3, A4, A5, A6, LEGAL, LETTER
pages	string The number of pages to create. May not be 0 or negative.

Responses

pdf.from.doc

This command is used to convert Word (.doc) to PDF.

Search Academy for more details about: pdf.from.doc.

Responses

pdf.from.docx

This command is used to convert Word(.docx) to PDF.

Search Academy for more details about: pdf.from.docx.

Responses

pdf.from.png

This command is used to convert PNG to PDF.

Search Academy for more details about: pdf.from.png.

Responses

pdf.merge

This command is used to merge PDFs.

Search Academy for more details about: pdf.merge.

Responses

pdf.stamp

Writes both text or images to a pdf file under a specific layer. It expects the pdf file as a pipeline resource in the body and transforms the result back also as a pipeline resource in the body.

Search Academy for more details about: pdf.stamp.

query Parameters

bottom_margin	string Considers page bottom margin when applying stamp.
fontColor	string The hex code color of the font like #FF0000, #0000FF
fontSize	string The size of the font.
font_family	string Considers font style that we can apply to stamp.
height	string Considers height of the text when applying stamp.
image	string The image to write on the pdf file. One of param text or image is required. The image must be a content uri an existing content object in the message or a built-in stamp name like APPROVED for example.
left_margin	string Considers page left margin when applying stamp.
opacity	number Amount of opacity that should be applied (Must be a value between >= 0.0 and <= 1.0, 0.0 means no opacity, 1.0 means invisible.)
right_margin	string Considers page right margin when applying stamp.
rotation	number Specifies how many degrees the element should be rotated. Negative degree means rotated below x-axis, positive degree means above. Must be a value between >= -180.0 and <= 180.0
text	string The text to write on the PDF file. It is required to either enter text or image.
top_margin	string Considers page top margin when applying stamp
width	string Considers width of the text when applying stamp.

Responses

pdf.to.png

This command is used to convert PDF to PNG.

Search Academy for more details about: pdf.to.png.

Responses

pinboard

pinboard.item.delete

Deletes a pinboard item of currently logged-in user.

Search Academy for more details about: pinboard.item.delete.

query Parameters

uuid	string The uuid of the pinboard item to delete.
value	string The value of the pinboard item to delete.

Responses

pinboard.item.get

Lists all pinboard items or returns a concrete one by uuid.

Search Academy for more details about: pinboard.item.get.

query Parameters

uuid	string The uuid of the pinboard item to return. If not given, all pinboard items of currently logged-in user will be returned, ordered by order value.

Responses

pinboard.item.put

Creates a new pinboard item or updates an existing one.

Search Academy for more details about: pinboard.item.put.

query Parameters

color	string The color of the icon. If null, the default color will be used.
icon	string The icon of the pinboard item. If null, a default icon will be used.
name required	string The name of the pinboard item.
order	string The order of the item in the pinboard as int value. ASC.
uuid	string The uuid of the pinboard item to update. If not given, a new one will be created.
value required	string The pinboard value.

Responses

pipeline

pipeline.debug.status

Returns the status of a running debugging session.

Search Academy for more details about: pipeline.debug.status.

query Parameters

pipelineKey	string (Deprecated, use pipelinePath instead) The property key of the pipeline to monitor. Required only on first call. Ignored if sessionId is set.
pipelinePath	string The property path of the pipeline to monitor. Required only on first call. Ignored if sessionId is set.
sessionId	string The debug session id. If null or empty, a new debugging session is created.

Responses

pipeline.delete

Deletes a persisted pipeline.

Search Academy for more details about: pipeline.delete.

query Parameters

name

required

string

The exact name of the pipeline to delete.

Responses

pipeline.get

Returns all persisted pipelines matching the given name.

Search Academy for more details about: pipeline.get.

query Parameters

name	string The name of the pipeline to search for. Supports wildcard * matching. If null or empty, returns all entries.

Responses

pipeline.put

Persists a new pipeline to the system or updates an existing one. The pipeline yaml is expected in the body. Can be null. Returns the updated property in the output.

Search Academy for more details about: pipeline.put.

query Parameters

name

required

string

The unique name of this pipeline within this namespace.

Responses

pipeline.run

Loads and executes the persisted pipeline and returns its result in the output.

Search Academy for more details about: pipeline.run.

query Parameters

headers	string A headers map to be put on this pipeline. Note: Any header in this map will overwrite the header in the target pipeline headers scope.
key	string Deprecated. Use path instead. The key of the pipeline in the property store to load and executed. Can be relative inside current namespace or qualified.
name	string DEPRECATED. Use param key instead. The key of the pipeline in the property store to load and executed. Can be relative inside current namespace or qualified.
path required	string The path of the pipeline in the property store to load and executed. Can be relative inside current namespace or qualified.
vars	string A variables map to be put on this pipeline. Note: Any var in this map will overwrite the var in the target pipeline vars scope.

Responses

portal

portal.config.get

Returns all global configuration values for the portal.

Search Academy for more details about: portal.config.get.

Responses

property

property.attachment.checksum

Calculates and verifies the checksum of a property attachment. Calculating the checksum of an attachment using this command also means closing it, so that no more chunks can be added. The checksum of an attachment is calculated by concatenating the MD5 of all chunks into a single MD5 digest.

Search Academy for more details about: property.attachment.checksum.

query Parameters

attachmentUuid	string The uuid of the attachment to be checked. If this is given, path and name params are ignored.
checksum	string The checksum to be used for verification. If not given, no verification is done, but checksum of attachment is calculated and stored anyhow.
collectionName	string The collection of attachment to be checked. If not specified, root attachment is expected.
key	string Deprecated. Use path instead. The key of the property containing the attachments.
name	string The name of the attachment to be checked.
path	string The path of the property containing the attachments.
uuid	string The uuid of the property containing the attachments. If this is given, path param is ignored.

Responses

property.attachment.chunk.content

Returns the content (data) of a chunk of an attachment in the output as input stream. Returns empty body if chunk was not found.

Search Academy for more details about: property.attachment.chunk.content.

query Parameters

attachmentUuid	string The uuid of the attachment this chunk belongs to. If this is given, path and name params are ignored.
collectionName	string The collection of attachment requested. If not specified, root attachment is expected.
index	string The index of the chunk to return.
key required	string Deprecated. Use path instead. The key of the property this attachment belongs to.
name	string The name of the attachment this chunk belongs to.
path	string The path of the property this attachment belongs to.

Responses

property.attachment.chunk.get

Returns the metadata of an chunk of an attachment. Throws error in case property or attachment doesn't exist. Return null in case no chunk exists at given index.

Search Academy for more details about: property.attachment.chunk.get.

query Parameters

attachmentUuid	string The uuid of the attachment this chunk belongs to. If this is given, path and name params are ignored.
collectionName	string The collection of attachment requested. If not specified, root attachment is expected.
index	string The index of the chunk to return.
key	string Deprecated. Use path instead. The key of the property this attachment belongs to.
name	string The name of the attachment this chunk belongs to.
path	string The path of the property this attachment belongs to.

Responses

property.attachment.chunk.put

Adds a chunk of data to the given attachment. Note: A chunk may not be bigger than 10MB. Otherwise, it gets rejected from the backend.

Search Academy for more details about: property.attachment.chunk.put.

query Parameters

attachmentUuid	string The uuid of the attachment to add the chunk to. If this is given, path and name params are ignored.
collectionName	string The collection of attachment. If not specified, root attachment is expected.
content	string The content to be added to the chunk. If this parameter is null or empty, the body will be used as content instead.
index	string The index of the chunk. If given, the content of the chunk at given index is replaced with the new content. If null or empty, a new chunk is added to the attachment.
key	string Deprecated. Use path instead. The key of the property this attachment belongs to.
name	string The name of the attachment this chunk belongs to.
path	string The path of the property this attachment belongs to.
storageId	string The id of the storage to be used in the backend to store the binary data of the attachment. Possible values: database, drive.

Responses

property.attachment.content

Returns the content of an property attachment as a byte stream content object into the output.

Search Academy for more details about: property.attachment.content.

query Parameters

attachmentUuid	string The uuid of the attachment to returns its content. If this is given, path and name params are ignored.
collectionName	string The collection of attachment. If not specified, root attachment is expected.
key	string Deprecated. Use path instead. The key of the property this attachment belongs to.
name	string The name of the attachment.
path	string The path of the property this attachment belongs to.

Responses

property.attachment.delete

Removes an attachment and its content from the property store.

Search Academy for more details about: property.attachment.delete.

query Parameters

attachmentUuid	string The uuid of the attachment to delete. If this is given, path and name params are ignored.
collectionName	string The collection of attachment to be deleted. If not specified, root attachment will be deleted.
key	string Deprecated. Use path instead. The key of the property containing the attachment.
name	string The name of the attachment to be deleted.
path	string The path of the property containing the attachment.

Responses

property.attachment.get

Returns an attachment of a property (without content).

Search Academy for more details about: property.attachment.get.

query Parameters

attachmentUuid	string The uuid of the attachment to return. If this is given, path and name params are ignored.
collectionName	string The collection of attachment requested. If not specified, root attachment is expected.
key	string Deprecated. Use path instead. The key of the property this attachment belongs to.
name	string The name of the attachment to return.
path	string The path of the property this attachment belongs to.

Responses

property.attachment.list

Lists all attachments of a given property. The content is not part of this list. Use property.attachment.chunk.get in order to retrieve the content data.

Search Academy for more details about: property.attachment.list.

query Parameters

collectionName	string The collection of attachments to list. If given, returns only those attachments which belong to this collection. Otherwise, all attachments are returned.
key	string Deprecated. Use path instead. The key of the property to list its attachments for.
path required	string The path of the property to list its attachments for.
propertyUuid	string The uuid of the property those attachments to return. If this is given, path is ignored.

Responses

property.attachment.put

Creates and adds an attachment to a property.
Optionally with binary payload data or content object in body.
Overwrites / updates any existing attachments with same name.
The attachment can be added in three ways:
A) A single content object or a collection of content objects in the input is given in input,
then its payload and metadata is used to create the attachment(s).
B) Data different to a content object is given in the input.
Then this data will be used as the payload for the attachment.
C) Input is null or empty. Then an empty attachment without any payload will be created.
In case B) and C) the additional parameters name, contentType and length are mandatory.
In case A) The parameters name, contentType and length are optional and will be used as forced
values if given.

Search Academy for more details about: property.attachment.put.

query Parameters

collectionName	string The collection (= folder) of the attachment. If not specified, attachment will be added to root "folder" (null).
content	string The content to add. If null, the data from input will be added. In case you would like to explicitly set no content at all (also not from the body), set this value to: false.
contentType	string The content type to be used for the attachment. Overwrites the value of the content object (if any).
createProperty	string Creates the property if it doesnt exist. Requires path param in case property must be created. If param is false and property doesnt exist, will cause an error.
key	string Deprecated. Use path instead. The key of the property containing the attachments.
length	string The length of the overall attachment. Length of content given in input (if any) must be equal to or smaller than this value.
name	string The forced name of the attachment to be created. If an attachment with this name already exists, updates the existing one. Overwrites the name of the underlying content object (if any).
path	string The path of the property this attachment will be added.
storageId	string The id of the storage to be used in the backend to store the binary data of the attachment. Possible values: database, drive.
uuid	string The uuid of the property this attachment will be added. If uuid is given, path param is ignored.

Responses

property.attachment.put.uri

Sets property attachment to be symlink to resource referenced by uri.

Search Academy for more details about: property.attachment.put.uri.

query Parameters

collectionName	string The collection of attachment. If not specified, root attachment will be created.
key	string Deprecated. Use path instead. The key of the property this attachment belongs to.
name required	string The name of the attachment.
path required	string The path of the property this attachment belongs to.
uri required	string The uri of resource to point symlink to.

Responses

property.copy

Copies a property from one key to another. If target property already exists, overwrites it. NOTE: Doesnt copy the attachments.

Search Academy for more details about: property.copy.

query Parameters

key	string Deprecated. Use path instead. The origin key of the property.Otherwise a new entry is created.
path	string The origin path of the property.Otherwise a new entry is created.
to required	string The target key to copy the property to. If a property with this key already exists, it will be overwritten.

Responses

property.count

Counts the properties by given pattern.

Search Academy for more details about: property.count.

query Parameters

includeTrashed

string

Include also properties moved to trash bin in the search?

pattern

required

string

pattern

required

string

The key pattern of the parent property or properties. Can be a static suffix like my/parent/path or my/parent/path/ or a pattern like my/parent/path/*. Nested patterns like my/*/path/* are not supported.

Responses

property.path.list

Returns all property paths for a given pattern.

Search Academy for more details about: property.path.list.

query Parameters

includeTrashed

string

Include also properties moved to trash bin in the search?

pattern

required

string

ignoreUuidField	string If this parameter contains a non-empty value, and the property value is a JSON type, tries to remove the uuid field with given name, so it is not stored to database. If this parameter is set but the JSON field doesn't exist or the property value is not a JSON, nothing happens.
key	string Deprecated. Use path instead. The key of the property to save the value to.
path required	string The path key of the property to save the value to.
value	string The value of the property to save. May be null or empty.

Responses

push

push.subscription.delete

Deletes a push subscription from property store and from cache.

Search Academy for more details about: push.subscription.delete.

query Parameters

uuid

required

string

The uuid of the subscription to delete.

Responses

push.subscription.flush

Causes a push subscription processing cycle to be executed. This is not intended for automated calls. Only for admin purposes. Too frequent calls of this command are forbidden and will be blocked.

Search Academy for more details about: push.subscription.flush.

Responses

push.subscription.get

Returns a subscription by uuid or null in case no such subscription exists.

Search Academy for more details about: push.subscription.get.

query Parameters

uuid

required

string

The uuid of the subscription to return.

Responses

push.subscription.list

Returns all push subscriptions as list.

Search Academy for more details about: push.subscription.list.

query Parameters

cached

string

Should the subscriptions from cache returned (true) or
those from property store (false). The latter one is the default if this
param is missing.

Responses

push.subscription.put

Creates or updates a push subscription by adding it to property store + caching it.

Search Academy for more details about: push.subscription.put.

Responses

resolve

Resolves a given PIPEFORCE uri to its content and returns it. For example $uri:property:global/app/myapp/mydata will return the value of the mydata property. Also see: https://docs.pipeforce.org/docs/api/uris

Search Academy for more details about: resolve.

query Parameters

uri

required

string

The PIPEFORCE uri of the content to resolve.

Responses

resource

Loads a resource depending on its resource protocol like classpath:, property: or alike.

Search Academy for more details about: resource.

query Parameters

path	string DEPRECATED. Use uri instead.
uri required	string The uri path to load the resource from. If it starts with classpath:pipeforce, a lookup in the classpath subfolder pipeforce is done (other locations are not allowed). If it starts with property: a lookup in the property store is done and the result is thevalue of the property if exists.

Responses

resource.save

Expects a resource base64 encoded in the body and saves it as a resource to hub.

Search Academy for more details about: resource.save.

query Parameters

path

required

string

The path to save the resource to.

Responses

result

result.complete

Completes a processing result. The input to the command will be set as completion value to the result. In case result with given id doesn't exist or was already completed, nothing happens. So calling this completion multiple times has no effect. First one wins. Also using this for polling (by checking for non-existing exception) will not work for performance and security reasons here.

Search Academy for more details about: result.complete.

query Parameters

correlationId required	string The id of the result to be completed.
value	string The optional value to be set on the result.

Responses

result.delete

Cancels and deletes a processing result. If result doesn't exist or was already cancelled, nothing happens. Will return information about the cancelled task if there was any.

Search Academy for more details about: result.delete.

query Parameters

correlationId

required

string

The id of the result to be cancelled.

Responses

result.get

Returns a result from the cache but without the result value. If the result value is required, use polling instead.

Search Academy for more details about: result.get.

query Parameters

correlationId

required

required

string

The url of the web page to open.

Responses

rpa.website.scrap

Scraps data from the current website and returns the result in the body.Note: The pipe is BETA and not intended to be used in production!

Search Academy for more details about: rpa.website.scrap.

query Parameters

xpath

required

string

Executes the given xpath expression on the current page and puts the result in the body. In case the xpath returns more than one results, adds an array to the body. Otherwise the body only contains the single result value.

Responses

script

script.groovy

Executes a groovy script.
See: https://groovy-lang.org/documentation.html
These default variables are always available inside the script:
headers, vars, body, request, response, context.
Note: If output parameter is not defined, nothing is written to output or body.

Search Academy for more details about: script.groovy.

query Parameters

args	string The additional args map to be passed to the script as name value pairs. They can be accessed via args.name.
code required	string (default) The Groovy script to be executed

Responses

script.run

Removed. This command is not longer supported. Consider to use function.run instead.

Search Academy for more details about: script.run.

Responses

secret

secret.delete

Deletes a credentials entry.

Search Academy for more details about: secret.delete.

query Parameters

name

required

string

The name of the credentials entry to delete.

Responses

secret.get

Lists the metadata (not the secret payload itself) of all available secret entries.

Search Academy for more details about: secret.get.

query Parameters

includeTrashed	string Also include the secret properties moved to trash bin in the list search?
name	string The name of a single credentials to return. If null or empty, all credentials will be returned.

Responses

secret.put

Creates a new credentials entry.

Search Academy for more details about: secret.put.

query Parameters

format required	string The format of the secret to store. One of: secret-text, bearer, header, username-password.
name required	string The unique name of the credentials.
secret required	string The secret part (for example the username:password or Bearer TOKEN).
timeToLive	string The time to live in minutes. After this time, the credentials will be deleted.

Responses

secretsend

secretsend.inbox.auth

Creates and verifies a magic link download token to access a given inbox transfer.

Search Academy for more details about: secretsend.inbox.auth.

query Parameters

cookieToken	string In order to improve security, set a cookie value in your browser (client) and make sure on second call of this command, the cookie token is read from client and put into this command. This way you can make sure, that the client which sends the magic token is the same as theone who initially requested it. This token is optional.
magicToken	string The magic token, sent to the recipient (via email) after he requested it.
outboxUuid required	string The uuid of the secret send outbox, the user needs access to.
recipientEmail required	string The email of the recipient to create the token for.

Responses

secretsend.inbox.download

Downloads the content of an attachment or a group of attachments.

Search Academy for more details about: secretsend.inbox.download.

query Parameters

filenames	string A list of one or more attachment filenames to be downloaded (comma separated or PEL list object). If this list is null or empty, all files of the inbox will be downloaded as single zip file. If only one file is defined, this file is downloaded plain. If there is more than one file defined, downloads all of these files as a single zip.
inboxUuid	string The uuid of the inbox transfer to return.
outboxUuid	string The uuid of the outbox transfer to return.

Responses

secretsend.inbox.get

Returns an inbox transfer by uuid.

Search Academy for more details about: secretsend.inbox.get.

query Parameters

inboxUuid

required

string

The uuid of the inbox transfer to return.

Responses

secretsend.inbox.list

Lists all inbox transfers targeted to a given recipient.

Search Academy for more details about: secretsend.inbox.list.

query Parameters

recipientEmail

string

outboxUuid

required

string

The uuid of the transfer in the outbox to delete.

Responses

secretsend.outbox.finalize

Finalizes a given secret send outbox: Creates inboxes for each recipient and sends notification email to each by default.

Search Academy for more details about: secretsend.outbox.finalize.

query Parameters

outboxUuid	string The uuid of the transfer outbox to finalize.
sendEmails	string Should the notification emails to the recipients created and send on this finalize?

Responses

secretsend.outbox.get

Returns the outbox by given uuid.

Search Academy for more details about: secretsend.outbox.get.

query Parameters

outboxUuid

required

string

The uuid of the transfer outbox to return.

Responses

secretsend.outbox.list

Lists all outbox transfer items created by the currently logged-in user.

Search Academy for more details about: secretsend.outbox.list.

Responses

secretsend.outbox.preview

Returns the preview for a given outbox, if supported by security settings.

Search Academy for more details about: secretsend.outbox.preview.

query Parameters

outboxUuid

string

enabled	string Is the recipient enabled = can download the transfer?
outboxUuid required	string The uuid of the transfer outbox to add the recipient to.
recipientEmail required	string The email of the recipient to add.
recipientLocale	string The locale to be used for this recipient like de, en or fr for example.
sendEmail	string Should be an email sent to the recipient?

Responses

server

server.info

Returns information about the current server. For example the version it is running under. Returns a flat JSON with these keys: status, namespace, domain, edition, stage, tag, build, version, versionMajor, versionMinor, versionBugfix

Search Academy for more details about: server.info.

Responses

service

service.job.logs

Returns the logs of a service job in the cluster.

Search Academy for more details about: service.job.logs.

query Parameters

credentials	string DEPRECATED. Use param secret instead.
name	string The name of the service job.

Responses

service.job.start

Starts a new service job in the cluster. The job runs async. Use service.job.status and service.job.logs to check the result of the job.

Search Academy for more details about: service.job.start.

query Parameters

args	string The list of args to be passed on to the service job container.
command	string The list of command to execute on the service job container.
credentials	string DEPRECATED. Use param secret instead.
env	string Environment variables to be applied to the job service container. Can contain 'secret-text' secret references with value like '$uri:secret:secretTextName', '$uri:webhook:token:keyToResolve'.
image	string The repo path of the image to be deployed. In case the image name starts with prefix 'pipeforce-registry/' the image will be loaded from the default PIPEFORCE registry for this namespace.
imagePullPolicy	string The policy how to handle non existing image. Can be one of: Always (pull image always from registry, to get latest), IfNotPresent (pull image from registry if not present), Never (pull image never from registry).
imagePullSecret	string The optional name of the registry secret to be used in case it is a private registry.
name	string The name of the service job.
replace	string If true, an existing job with same name will be deleted before this new one is created. If false, an exception is thrown in case a job with same name already exists.

Responses

service.job.status

Returns the status of a service job in the cluster.

Search Academy for more details about: service.job.status.

query Parameters

credentials	string DEPRECATED. Use param secret instead.
name	string The name of the service job.

Responses

service.job.stop

Stops a service job in the cluster even if it is not finished yet.

Search Academy for more details about: service.job.stop.

query Parameters

credentials	string DEPRECATED. Use param secret instead.
name	string The name of the service job.

Responses

service.start

Starts a new microservice in the cluster.

Search Academy for more details about: service.start.

query Parameters

args	string The list of args to be passed on to the service container.
command	string The list of command to execute on the service container.
credentials	string DEPRECATED. Use param secret instead.
env	string Map of environment variables to be applied to the service container. Can contain 'secret-text' secret references with value like '$uri:secret:secretTextName' or webhook references like '$uri:webhook:eventKey' which will be resolved and passed to the container.
image	string The repo path of the image to be deployed. If empty, no image will be deployed (just the service slot created). In case the image name starts with prefix 'pipeforce-registry/' the image will be loaded from the default PIPEFORCE registry for this namespace.
imagePullPolicy	string The policy how to handle non existing image. Can be one of: Always (pull image always from registry, to get latest), IfNotPresent (pull image from registry if not present), Never (pull image never from registry).
imagePullSecret	string The optional name of the registry secret to be used in case it is a private registry.
ingress	boolean Expose the given port of the service to the internet? The service is then reachable via HTTPS using the url https://[serviceName]-[namespace].pipeforce.net.
name	string The name of the service.
port	number The port the running service accepts requests.
replicas	string The number of stateless replicas (= scaling instances) of this service to be started in parallel in the cluster by default.
volumes	string The list of paths inside the container to mount to persisted volumes. This will automatically create a persistent volume and stores the data in the given paths to this volume. By default, the volume will be kept even on stop and start of the container. See service.stop command.

Responses

service.status

Returns the status info of the given PIPEFORCE managed service.

Search Academy for more details about: service.status.

query Parameters

credentials	string DEPRECATED. Use param secret instead.
format	string The format of the status output: How much status information must be returned? Can be one of compact, normal, full.
name	string Name of the service. If null or empty, the status of all PIPEFORCE managed services in current namespace will be returned.

Responses

service.stop

Stops a microservice from the cluster.

Search Academy for more details about: service.stop.

query Parameters

credentials	string DEPRECATED. Use param secret instead.
deleteVolumes	string If set to true, any volume declared on service.start will be deleted.
name	string The name of the microservice to be stopped.

Responses

set

Sets a value in the pipe message. The value to be set can be a constant or an expression.

Search Academy for more details about: set.

query Parameters

mapping	string A list of mapping rules to be applied to the given input value.
to	string DEPRECATED. Use param output instead.
value required	string (default) A string or an expression to be used as the value to be set.

Responses

sftp

sftp.delete

Deletes a file or folder on the SFTP server.

Search Academy for more details about: sftp.delete.

query Parameters

credentials	string DEPRECATED. Use param secret instead.
host	string The host
password	string The password
path	string The path to the file or folder to delete. If path ends with / a folder is expected to be deleted.
port	string The port
secret	string Refers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.
username	string The username

Responses

sftp.download

Downloads a file from a SFTP server. The file is written as content object to output.

Search Academy for more details about: sftp.download.

query Parameters

credentials	string DEPRECATED. Use param secret instead.
host	string The host
password	string The password
path required	string The path of the file to download.
port	string The port
secret	string Refers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.
username	string The username

Responses

sftp.list

Lists files of a given folder. If not filter parameter is used all files are returned. The result is written to output.

Search Academy for more details about: sftp.list.

query Parameters

credentials	string DEPRECATED. Use param secret instead.
filter	string The filter to apply to files list. '?' - match one character, '' - match zero o more characters, '\' to match '*' in filename
host	string The host
password	string The password
path	string The path to the folder to list.
port	string The port
secret	string Refers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.
username	string The username

Responses

sftp.mkdir

Creates a new directory on the SFTP server.

Search Academy for more details about: sftp.mkdir.

query Parameters

credentials	string DEPRECATED. Use param secret instead.
host	string The host
password	string The password
path required	string The path where to create the folder.
port	string The port
secret	string Refers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.
username	string The username

Responses

sftp.rename

Renames a file or folder on the SFTP server.

Search Academy for more details about: sftp.rename.

query Parameters

credentials	string DEPRECATED. Use param secret instead.
fromPath	string The origin path to the resource to rename.
host	string The host
password	string The password
port	string The port
secret	string Refers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.
toPath	string The new path / name of the resource.
username	string The username

Responses

sftp.upload

Uploads a file to a SFTP server. The file is expected to be in the input.

Search Academy for more details about: sftp.upload.

query Parameters

credentials	string DEPRECATED. Use param secret instead.
host	string The host
password	string The password
path	string The path to upload to. If this ends with a slash / it is expected to be a folder name. The file name will be attached from the input file which must be a content object in this case.
port	string The port
secret	string Refers to the name of a stored secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.
username	string The username

Responses

slack

slack.send

Sends a text message via webhook url to Slack. Also see: https://api.slack.com/messaging/webhooks

Search Academy for more details about: slack.send.

query Parameters

text required	string The text message to be send to Slack.
url required	string The Slack webhook url to post the message to. See here to generate one: https://api.slack.com/messaging/webhooks

Responses

sql

Executes a SQL query and returns the result as JSON in the body.
The result size is limited to 1000 result rows. If you need more, use pagination or filter the result.
NOTE: This command is primarily meant for developers and support to monitor the system.
It must NOT be used in production apps! It can change at any time without notice!

Search Academy for more details about: sql.

query Parameters

datasource	string The name of the datasource to be used. Examples: hub, drive, workflow
format	string The format of the result. Must be one of: array, object
includeColumnNames	string In case format is array, should the first row contain the column names?
params	string Optional SQL parameter map. Values can be accessed via :name inside SQL query.
query	string The SQL query to be executed.

Responses

sql.describe

Returns information about the given datasource.

Search Academy for more details about: sql.describe.

query Parameters

columns	string Include column info on each table?.
datasource	string The name of the datasource to be used.
schemas	string Include table info?.
tables	string Include table info?.

Responses

stats

Returns basic status information about the hub service.

Search Academy for more details about: stats.

Responses

switch

Evaluates each switch statement. Takes the value part of the first match and writes it to the given output. If no output is given, writes it to the body. Any param key will be the selection expression which needs to evaluate to a boolean true or false and any value will be the selected value.

Search Academy for more details about: switch.

Responses

terms

terms.delete

Deletes a terms by its name.

Search Academy for more details about: terms.delete.

query Parameters

locale	string The locale of the terms to delete.
name required	string The name of the terms to delete.

Responses

terms.get

Returns a terms by its name and locale.

Search Academy for more details about: terms.get.

query Parameters

locale	string The locale of the terms to return. If this param missing, the default locale will be used.
name required	string The name of the terms to return.

Responses

terms.list

Returns all terms. The name and and locale, each. But not the text.

Search Academy for more details about: terms.list.

Responses

terms.put

Adds a new terms entry to the property store.

Search Academy for more details about: terms.put.

query Parameters

locale	string The locale of the terms
name required	string The name of the terms
system	string Is it a system term? Attention: Cannot be deleted via commands!
text	string The terms text. If this parameter is missing, the value from the body will be used.

Responses

terms.text.get

Returns the terms text by its name and locale.

Search Academy for more details about: terms.text.get.

query Parameters

locale	string The locale of the terms to return.
name required	string The name of the terms to return.

Responses

test

test.run

Runs all test scripts defined by given pattern asynchronously.

Search Academy for more details about: test.run.

query Parameters

dryRun	string This param will skip real test execution. Instead it will return all found tests using the given status. This is mainly for testing DevOp tasks in order to make sure integrated tests work as expected. Possible values are: passed, failed, error, ignored
functionExcludePattern	string A PE which defines the test functions to be excluded from the list of included test functions. The function method name is provided as variable: functionName. By default all test functions, ending in IT will be ignored.
functionIncludePattern	string A PE which defines the test functions to be included. The selected method name is provided as variable: functionName.
locations	string The location patterns, selecting all tests in the property store to be selected for test runs.
pollingRedirectEnabled	string Should the response contain a 503 status (redirect) in case the result is not finished yet so a long polling is possible? If true, the 503 status is returned to the caller with a target url. If caller client follows this redirect, it can long poll on the target url for the final result. The test ALWAYS starts async in the backend. Therefore, if a final result is expected, it must be retrieved always using long polling or a message listener.
reportFormat	string The format of the resulting test report. Possible values: json (default), junit
waitBeforeStart	string The time to wait in ms before the the test run starts.

Responses

theme

Returns the resources for a given theme in the body and enrich headers with appropriate Content-type. Caches the resources where applicable.

Search Academy for more details about: theme.

query Parameters

clearCache	boolean If true, the current theme cache is cleared.
contentType	string The content type to be returned as fallback in case there is none defined at backend side for the requested resource. If this param is missing, it will be tried to guess the type automatically. If the type could not be guessed, returns application/octet-stream by default.
name	string The name of the theme. If not given, the default theme will be used as configured.
ref	string The optional referrer id to this resource request.
resource required	string The name of resource to be loaded. If it starts with a slash / tries to load the resource from the default location with given name. If resource is one of the default names like: background, logo, pipeforce-logo, tries to load the default resource for these names. If null or invalid value, falls back to default value.

Responses

transform

This transformer converts the input to an output format by applying the given template engine. By default the current message is provided as model inside the template context so you can access body, vars or headers similar to the default PEL approach.

Search Academy for more details about: transform.

query Parameters

engine	string The template engine to be used. Currently 'freemarker' and 'pel' is supported.
groupBy	string An expression to apply on the target list in order to group the result of a row into. If the expression returns false, the row result is added to the end of the list.If null or empty, each row result creates a new entry in the target list.
iterate	string If true, the input is expected to be a list which will be iterated. The template is then applied on each iteration row and the result is added to a target list.
modelName	string The name of the root model under which the input can be accessed inside the template. If null or empty, then the input defines the model names.
template required	string The template to be used for the transformation. It can the template text itself as string or a qualified uri pointing to a template resource like this for example: $uri:property:/my/template/path

Responses

transform.csv.json

Takes a CSV document in the body and converts it to a JSON. The CSV document must comply with the RFC4180 standard format.

Search Academy for more details about: transform.csv.json.

query Parameters

delimiter	string The delimiter (separator) to separate the columns of the CSV
hasHeadersLine	string Does the first line of the input CSV contain the column header names?
rowsFormat	string The JSON format of the rows section: arrays (= array with nested string arrays with each CSV line as such a new nested array), objects (= each CSV line will become a new JSON object in the rows array with the CSV headers as the field keys)
showColumnsCountField	string Show the number of headers (columns) in element columnsCount?
showHeadersField	string Show the column header names in extra element headers? This is only shown if hasHeaders is true. In this case, the values array doesnt contain a first headers line.
showRowsCountField	string Show the number of rows (values) in element rowsCount?

Responses

transform.ftl

This transformer uses the FreeMarker template engine for its transformation.

Search Academy for more details about: transform.ftl.

query Parameters

model	string The model to be placed into the template scope. If null, the message is used as model so you can access vars and body the same way as you would do in the pipeline.
template	string The template to be used for the transformation. If this param null, the template text is expected in the body. It can be a static template text or a qualified PIPEFORCE URI (for example $uri:property:/my/template/path) pointing to the template text. Pipeline expressions in this param are not supported here since they would conflict with the template variables.

Responses

transform.html2docx

Takes html text that is expected in the body, (as pipeline resource) and converts it back to docx document and then writes to output.

Search Academy for more details about: transform.html2docx.

Responses

transform.json.html

Transforms a given JSON document by input into a simple HTML structure with ul and li elements which is mainly intended for better human readability in an HTML browser.

Search Academy for more details about: transform.json.html.

Responses

query Parameters

scheme

string

The conversion scheme to be used. If null or empty, the default PIPEFORCE rules apply. If set to 'jackson', the rules defined by XML Jackson will be applied.

Responses

translate

Translates the given text to the given target language. Expects the input by default in the body and writes the result by default back to the body.

Search Academy for more details about: translate.

query Parameters

apiKey	string The alternative API key to connect to the service. If null or empty, the default one will be used, as defined by the default backend settings.
filter	string A PEL as filter to be applied to the output data before it is returned by this command. If null or empty, no filter is applied.
restUrl	string The URL to be called by the command. If null or empty, the default url will be used as defined in the backend.
secret	string The secret text to be used. Expects the translate service API token and url stored in the secret store under this name. The entry must be a JSON like this {'restUrl':'', 'apiKey':''}.
targetLanguage	string The target language to transform the text to. Supported values: DE, EN, FR, IT, JA, ES, NL, PL, PT, RU, ZH
text required	string The text to be translated.

Responses

unzip

Unzips a given zipped content from the body and puts the uncompressed content as collection into the output. Note: After pipeline has been finished, uncompressed content is gone.

Search Academy for more details about: unzip.

Responses

usage

usage.cache.flush

Writes all usage data immediately to storage, mainly for testing purposes. This is usually done automatically.

Search Academy for more details about: usage.cache.flush.

Responses

usage.keys.list

Returns the list of all usage keys.

Search Academy for more details about: usage.keys.list.

Responses

usage.stats.get

Returns the usage stats for a given usage key.

Search Academy for more details about: usage.stats.get.

query Parameters

key

required

string

The usage key those statistics to return.

Responses

user

user.notification.delete

Deletes a user notification.

Search Academy for more details about: user.notification.delete.

query Parameters

uuid	string The uuid of the notification to delete.

Responses

user.notification.list

Returns all notifications targeted to the currently logged-in user.

Search Academy for more details about: user.notification.list.

query Parameters

locale	string The locale of the notification. If null or empty, all available notifications in any language will be returned for this user.
read	string If true, returns only those notifications, already read. If false, returns only those notifications, not yet read. If empty or missing, returns all notifications.

Responses

user.notification.markread

Marks a given user notification as read. Note: The logged-in user must be the user, the
notification is for in order to be able to mark it as read.

Search Academy for more details about: user.notification.markread.

query Parameters

uuid	string The uuid of the notification

Responses

user.notification.put

Creates a new user notification.

Search Academy for more details about: user.notification.put.

query Parameters

background	string The background color of the notification
banner	string Should the notification be shown in the top banner?
button	string The text to be shown on the button
icon	string The icon of the notification
locale	string The locale of the notification
message	string The message of the notification
targetUsers required	string The list of users to show this notification for. If *, notification will be shown to all.
timeToLive	string The time to live in minutes. After this time, the notification will be deleted. If null or empty, will be kept forever.
title	string The title of the notification

Responses

var

var.set

Sets a value in the vars scope. Overwrites any existing var in the vars scope. The value to be set can be a constant or an expression.

Search Academy for more details about: var.set.

query Parameters

format	string Converts a string value to the given target format if possible. If set to 'auto' tries to detect the target format by inspecting the value string. If set to 'none' doesnt apply any conversion.
key required	string A string or an expression to be used as key of the var to be set.
value required	string A string or an expression to be used as the value to be set.

Responses

vars

This command allows to set multiple variables in one command. It can create new variables in the vars scope or overwrite existing ones.

Search Academy for more details about: vars.

query Parameters

set

required

string

(default) A list of key-value pairs to be evaluated in order to set variables.

Responses

wait

Waits a certain amount of time with next execution.

Search Academy for more details about: wait.

query Parameters

ms	string (default) The time to wait in milliseconds.

Responses

webhook

webhook.delete

Deletes an existing webhook. If no such webhook exists, nothing happens.

Search Academy for more details about: webhook.delete.

query Parameters

uuid

required

string

token

required

string

The unique token of the webhook to list logs for.

Responses

workflow

workflow.assert

Applies asserts for a given workflow in the workflow service.

Search Academy for more details about: workflow.assert.

query Parameters

processFinished	string If true, checks whether the process with given id has been finished.
processInstanceId required	string The id of the process instance the task to check belongs to.
taskFinishedById	string A comma separated list of task definition ids (not names!) to check whether they have been finished.
taskFinishedByName	string A comma separated list of task names to check whether they have been finished.
taskNotFinishedById	string A comma separated list of task definition ids (not names!) to check whether they have not yet finished.
taskNotFinishedByName	string A comma separated list of task definition names to check whether they have not yet finished.
throwException	string If true, throws exception when at least one of the assert params is false. Otherwise returns the query result of the last assert in the body.

Responses

workflow.authorization.delete

Deletes an authorization by its id.

Search Academy for more details about: workflow.authorization.delete.

query Parameters

authorizationId

string

The id of the authorization to delete.

Responses

workflow.authorization.find

Finds authorizations by given query parameters.
See: https://docs.camunda.org/rest/camunda-bpm-platform/7.21/#tag/Authorization/operation/queryAuthorizations

Search Academy for more details about: workflow.authorization.find.

query Parameters

query

string

workflow.definition.deploy

Deploys a given BPMN from the body or a given property into the underlying workflow engine.

Search Academy for more details about: workflow.definition.deploy.

query Parameters

appId	string The appId to be used to prefix the process name with: appId_workflowname. If null or empty no prefix is appended.
name required	string The name to deploy the workflow under.
propertyKey	string DEPRECATED. Use propertyPath instead.
propertyPath	string The optional path of a workflow property containing a BPMN as value. If this is given, name and appId will be extracted from this key in case these params are empty. If this param is missing, the BPMN is expected to be in the body.

Responses

workflow.definition.details.find

Returns all workflow definition details without loading the full BPMNs.

Search Academy for more details about: workflow.definition.details.find.

query Parameters

locale

string

If given, the name of the process definitions returned will be translated to this locale in case an i18n translation exists for it.

Responses

workflow.definition.find

Returns all workflow definition properties from the property store, the currently logged-in user is allowed to see.

Search Academy for more details about: workflow.definition.find.

Responses

workflow.definition.undeploy

Undeploys a given BPMN from workflow engine.

Search Academy for more details about: workflow.definition.undeploy.

query Parameters

name

required

string

filterId

string

mappings

string

taskId

required

string

The id (not name!) of the task to claim.

Responses

workflow.process.delete

Deletes a given process.

Search Academy for more details about: workflow.process.delete.

query Parameters

processInstanceId

required

string

The id of the process instance to be deleted.

Responses

workflow.process.find

Returns all process instances matching the given criteria.

Search Academy for more details about: workflow.process.find.

query Parameters

active	string If true, only active processes are returned.
completed	string If true, only completed processes are returned.
finished	string If true, only completed and terminated processes are returned.
includeVariables	string If true, includes the process variables for each instance.
locale	string If given, the name of the process instances returned will be translated to this locale in case an i18n translation exists for it.
max	number The max number of entries to return. May not be greater than 100.
offset	number The offset to start return entries.
processDefinitionKey	string Filter by BPMN name.
processInstanceBusinessKey	string Filter tasks by businessKey.

Responses

workflow.process.get

Returns the process instance matching the given id.

Search Academy for more details about: workflow.process.get.

query Parameters

processInstanceId

required

string

taskId

required

string

taskId

required

string

The id of the task to check permissions for.

Responses

query Parameters

taskId

required

string

level	string Sets the compression level 0-9. If not set, the default level is used which could vary.
name	string The name of the final zip file. If not given, the name will be set by this rule: If it is a single entry, uses the name of the entry + .zip. If there are multiple entries, creates a random name + .zip

Responses

@calc

@calc.sum

Does a "nice" sum the values of the given list with high precision.
If an item in the given list is a string, it will be tried
to convert it to a number. If the value is null or cannot be converted it will be excluded from
the summary but no exception is thrown -> be nice.

Search Academy for more details about: @calc.sum.

query Parameters

list	object The list of numbers to sum-up.

Responses

@calc.avg

Calculates the average on the value of given list with a precision of two decimal points.

Search Academy for more details about: @calc.avg.

query Parameters

list	object The list of numbers.

Responses

@calc.round

Rounds input to scale number of digits. Multiple rounding strategies can be applied.

Search Academy for more details about: @calc.round.

query Parameters

value	object The value to round. BigDecimal, double, float, integer and long are supported.
scale	integer The scale to round to. Positive value scales in fraction part, negative in integer.
mode	string One of UP, DOWN, CEILING, FLOOR, HALF_UP, HALF_DOWN, HALF_EVEN, UNNECESSARY can be used. For details see https://docs.oracle.com/javase/7/docs/api/java/math/RoundingMode.html

Responses

@calc.roundUp

Rounds input to scale number of digits up.
See also {@link CalcPelUtil#round(Object, Integer, String)} for more options.

Search Academy for more details about: @calc.roundUp.

query Parameters

value	object The value to round. BigDecimal, double, float, integer and long are supported.
scale	integer The scale to round to. Positive value scales in fraction part, negative in integer.

Responses

@calc.roundDown

Rounds input to scale number of digits down.
See also {@link CalcPelUtil#round(Object, Integer, String)} for more options.

Search Academy for more details about: @calc.roundDown.

query Parameters

value	object The value to round. BigDecimal, double, float, integer and long are supported.
scale	integer The scale to round to. Positive value scales in fraction part, negative in integer.

Responses

@config

@config.value

Returns the configuration value from given app with given key.

Search Academy for more details about: @config.value.

query Parameters

scope	string The name of the scope (e.g. the app name) to look-up the config inside.
key	string The config key. If global config is defined its value is returned. Otherwise, app config value.

Responses

@config.value

Returns the global configuration with given key.

Search Academy for more details about: @config.value.

query Parameters

key	string The global config key.

Responses

@content

@content.newCollection

Creates a new content collection and initializes it with given uris.

Search Academy for more details about: @content.newCollection.

query Parameters

uris	string The list of content uris to add to the new collection.

Responses

@content.newCollection

Creates a new, empty content collection at given location.

Search Academy for more details about: @content.newCollection.

Responses

@content.newContent

Creates a new uri content object and returns it.

Search Academy for more details about: @content.newContent.

query Parameters

uri	string The uri to be used for the content object

Responses

@content.fromBase64

Wraps the given base64 string into a content object

Search Academy for more details about: @content.fromBase64.

query Parameters

base64String

string

query Parameters

o	object The object to convert to a map or list structure.

Responses

@convert.lazy

Converts all supported uri variants to LazyUriMap

Search Academy for more details about: @convert.lazy.

query Parameters

uri	string The uri to load from.

object

The object to convert.

Responses

@currency

@currency.normalize

Normalizes a given number string in several steps:

Removes any code or unit symbol and other non-number chars including whitespaces from the number
string expect periods and commas.

Removes the thousand separator (if given).

Makes sure the decimal separator becomes the period .

Examples:

@normalize("€1.234,56", ",") -> 1234.56

@normalize("$1,234.56", ".") -> 1234.56

@normalize("1,234.56", ".") -> 1234.56

@normalize("1,234.56", ",") -> 1234.56

@normalize("EUR 123 456,00", ",") -> 123456.00

1

Search Academy for more details about: @currency.normalize.

query Parameters

currencyString	string The currency string to normalize. Can be any currency value string with or without currency symbol or code.
thousandSeparator	string The thousand separator to be used. If null or empty, it will be tried to guess from the currency string.

Responses

@currency.subunitize

Converts the given currency number into its subunit by detecting the subunit ratio first
and then multiplying with it. Examples:

subunitize(100,00, "EUR") = 10000 EUR Cents

subunitize(100,00, "USD") = 10000 USD Cents

subunitize(100,00, "JPY") = 100 JPY

Hint: This is usually done before currency values are stored in the backend since it is
easier to handle and calculate with integer values instead of floats.

Search Academy for more details about: @currency.subunitize.

query Parameters

number	bigdecimal The amount of base unit to convert to subunits.
currencyCode	string The currency code or symbol the number is given in, in order to detect subunit from.

Responses

@currency.subunitize

Same as {@link #subunitize(BigDecimal, String)} but accepts a currency string as input.
The string will be normalized first.

Search Academy for more details about: @currency.subunitize.

query Parameters

currencyString	string The currency string to be normalized and then used to subunitize.
thousandSeparator	string The grouping separator to be applied when normalizing.
currencyCode	string The currency code or symbol the currency string is given in, in order to detect subunit from.

Responses

@currency.subunitize

Same as {@link #subunitize(BigDecimal, String)} but accepts a currency string as input.
The string will be normalized first but trying to guess the thousand separator.

Search Academy for more details about: @currency.subunitize.

query Parameters

currencyString	string The currency string to be normalized and then used to subunitize.
currencyCode	string The currency code or symbol the currency string is given in, in order to detect subunit from.

Responses

@currency.subunitRatio

Returns the ratio required to convert a value given as currency base (like EUR)
to its subunit (like Cent). This is the value, the base unit needs to be multiplied with
in order to get the subunit amount (for example if ratio 100: 1 EURO x 100 : 100 Cents).
Since the ratio depends on the currency, this method must be consulted for the
required currency. For Japanese Yen for example, the ratio is 1, not 100.

Search Academy for more details about: @currency.subunitRatio.

query Parameters

code	string The currency code or symbol.

Responses

@currency.groupingSeparatorByLang

Returns the (thousand) grouping separator for the given locale (language) string.
Examples:

DE = ,

US = .

GB = .

Search Academy for more details about: @currency.groupingSeparatorByLang.

query Parameters

lang	string The country/language string to return the grouping separator for. For example: DE or US, ...

Responses

@currency.defaultGroupingSeparatorByCode

Returns the default grouping (thousand) separator by given currency code or symbol.
Note: Since the grouping separator could differ by language, even if the same currency is used,
this will return only a default value. If you need to concrete separator you should use
{@link #groupingSeparatorByLang(String)} instead. The default value is , for EUR and . for
any other code.
Examples:

EUR : .

GBP : ,

USD : ,

Search Academy for more details about: @currency.defaultGroupingSeparatorByCode.

query Parameters

code	string The code, symbol or currency string to guess the default separator from.

Responses

@currency.guessGroupingSeparator

Tries to guess the grouping (thousand) separator from the given currency string.

Search Academy for more details about: @currency.guessGroupingSeparator.

query Parameters

currencyString

string

Can by any currency string like $1.000.000 or 123,456.00 for example.
Any currency unit or symbol will be ignored for the check.

Responses

@currency.code

Returns the ISO 4217 (see: https://en.wikipedia.org/wiki/ISO_4217) currency code
of a given currency string, symbol or code.
Some examples:

€ returns: EUR

$ returns: USD

£ returns: GBP

EUR returns: EUR

USD returns: USD

$ 1.000 returns: USD

1,00 EUR returns: EUR

Search Academy for more details about: @currency.code.

query Parameters

currencyString

string

The currency string containing the symbol or the currency code.

Responses

@data

@data.set

Sets the given value on the given data object at the given element path where every item is separated by a dot.
If an item at the given path doesnt exist, it will be created automatically (is supported by given object).
For example to create a new entry person.name inside a given map, you could use:
set(someMap, "person.name", "Some Name"). This will create the nested map person with an entry of
type name in it.

Search Academy for more details about: @data.set.

query Parameters

data	object The data object.
path	string The path inside the data object to set the value.
value	object The value to set.

Responses

@data.put

Expects the given data to be map-like structure and puts the given value under given key to it.
Overwrites any existing entry under this key.

Search Academy for more details about: @data.put.

query Parameters

data	object The map-like data structure.
key	object The key to add the value under.
value	object The value to add.

Responses

@data.select

Applies the given selection string on the given input object in order to extract
data from the input object. If there is more than one selection string, puts the
result of each string into a new map entry whereas the key is the selection string
or the name from the "AS NAME" suffix (note the upper case AS). Examples of selection strings:

'person.firstName' = Extracts the firstName from the input object and returns the result as a
entry in the mapping using the key 'person.firstName'. If it is the only selection string, returns the
value directly.

'person.firstName AS name' = Extracts the firstName from the input object and returns the result as a
entry in the mapping using the key 'name'

'person.hobbies.size()' = Extracts the number of hobbies from the input object and returns the result as a
entry in the mapping using the key 'person.hobbies.size()'. If it is the only selection string, returns the
value directly.

'person.hobbies.size() AS numOfHobbies' = Extracts the number of hobbies from the input object and returns
the result as an entry in the mapping using the key 'numOfHobbies'

Search Academy for more details about: @data.select.

query Parameters

input	object The input to apply the selection strings on. May not be null.
selections	string One or more selection strings. If null or empty, returns an empty map.

Responses

@data.jmespath

Applies the given JMESPath query on given input and returns the
query result.

Search Academy for more details about: @data.jmespath.

query Parameters

query	string The JMESPath query to be executed. See: https://jmespath.org/
input	object The input to apply the query on.

Responses

@data.jsonpath

Applies the given JSONPath query on given input and returns the
query result.

Search Academy for more details about: @data.jsonpath.

query Parameters

query	string The JSONPath query to be executed. See: https://goessner.net/articles/JsonPath/
input	object The input to apply the query on.

Responses

@data.integerList

Creates a new list and fills it with integers from startIndex up to endIndex.
For example a call of createListWithIntegers(2, 5) would return a list with these entries:
[2,3,4,5].

Search Academy for more details about: @data.integerList.

query Parameters

startInt	int The start index to fill the list.
endInt	int The end index to fill the list up to.

Responses

@data.size

Calculates the size of the given value regardless of the type it is.

Search Academy for more details about: @data.size.

query Parameters

value

object

The value to count for size.

Responses

@data.isEmpty

Checks if given data structure is null or empty.
For example:

If it is a list, returns true in case the list contains no entry or is null.

If it is a map, returns true in case the map contains no entry or is null.

If it is a node, returns true in case the node contains no entry or is null.

If it is a string, returns true in case the string contains no chars or is null.

Search Academy for more details about: @data.isEmpty.

query Parameters

data	object The data structure to check.

Responses

@data.remove

Removes the field with given key at first level of the given data object.

Search Academy for more details about: @data.remove.

query Parameters

data	object The object data to apply the removal at.
key	string The key of the field to remove.

Responses

@data.has

Checks whether given data object has an attribute, member or getter with given name.
Also supports property path syntax for recursive search on given data object.
Whereas each property name must be separated by a dot.
For example: person.firstName

Search Academy for more details about: @data.has.

query Parameters

data	object The data object to scan for attribute.
attribute	string The attribute name to search for.

Responses

@data.get

Returns the value of the given data attribute or null in case it doesn't exist.
This way an additional attribute non-existent check can be avoided.

Search Academy for more details about: @data.get.

query Parameters

data	object The data to read the value from.
attribute	string The attribute name to read from the data.

Responses

@data.emptyObject

Returns a new empty object (map).

Search Academy for more details about: @data.emptyObject.

Responses

@data.emptyList

Returns a new empty list.

Search Academy for more details about: @data.emptyList.

Responses

@data.keys

Returns the keys of the given object at root level. Which could be a JSON object for example.
If the object doesn't have a key, returns empty list. Never null.

Search Academy for more details about: @data.keys.

query Parameters

data	object A key value structure.

Responses

@data.type

Returns the type of the given data object. Can be one of:

OBJECT = A (JSON) object.

ARRAY = A (JSON) array.

STRING = A (JSON) string.

NUMBER = A (JSON) number.

BOOLEAN = A (JSON) boolean.

NULL = A (JSON) null.

Search Academy for more details about: @data.type.

query Parameters

data	object The data to check the type for.

Responses

@data.isType

Checks whether the given data is of given type. Valid type keys are:

OBJECT = A (JSON) object.

ARRAY = A (JSON) array.

STRING = A (JSON) string.

NUMBER = A (JSON) number.

BOOLEAN = A (JSON) boolean.

NULL = A (JSON) null.

Search Academy for more details about: @data.isType.

query Parameters

data	object The data to check for the type.
type	string The type string to check for.

Responses

@data.isArray

Checks if given data is an array.

Search Academy for more details about: @data.isArray.

query Parameters

data	object The data to check for.

Responses

@data.isBoolean

Checks if given data is a boolean.

Search Academy for more details about: @data.isBoolean.

query Parameters

data	object The data to check for.

Responses

@data.isNumber

Checks if given data is a number.

Search Academy for more details about: @data.isNumber.

query Parameters

data	object The data to check for.

Responses

@data.isObject

Checks if given data is an object.

Search Academy for more details about: @data.isObject.

query Parameters

data	object The data to check for.

Responses

@data.isString

Checks if given data is a string.

Search Academy for more details about: @data.isString.

query Parameters

data	object The data to check for.

Responses

@data.isNull

Checks if given data is null.

Search Academy for more details about: @data.isNull.

query Parameters

data	object The data to check for.

Responses

@data.load

Tries to auto-convert the given object to a data object (= map or list)
and loads it into memory in order to be able to
access it inside the pipeline.

Search Academy for more details about: @data.load.

query Parameters

content

object

The content to be loaded as data into memory.

Responses

@date

@date.now

Returns the current time at server side formatted using the preferred zone and locale of the currently logged-in user.

Search Academy for more details about: @date.now.

Responses

@date.nowIso8601

Returns the current time at server side formatted using the ISO8601 time format.

Search Academy for more details about: @date.nowIso8601.

Responses

@date.now

Returns the current time at server side formatted using the preferred zone and locale of the currently logged-in user.

Search Academy for more details about: @date.now.

query Parameters

format

string

dateString

string

A date string like 31.02.2012, 31.02.12, 2012/01/31, 31-01-12, 31-01-2012, 2012-01-31 23:59:59,
or 2001-07-04T12:08:56.235-0700.

Responses

query Parameters

timestamp	long The epoch millis to calculate the beginning of the year from. If null, the current timestamp will be used.
yearOffset	int The years to be added (positive value) or subtracted (negative value) from given year.

Responses

@date.beginOfMonth

Returns the epoch timestamp in millis of the beginning of the month relative to current month
with respect of the user's preference for time zone.
For example to get the timestamp of the beginning of the current month,
you would set monthOffset=0. To get the beginning timestamp of
last month, you would set monthOffset=-1. To get the beginning timestamp of
next month, you would set monthOffset=1.

Search Academy for more details about: @date.beginOfMonth.

query Parameters

monthOffset

int

dayOffset

int

timestamp	long The base timestamp in millis.
years	int The years to add (will be converted to millis).

Responses

@function

@function.run

Executes the FaaS function with given name and passes the given args to it.

Search Academy for more details about: @function.run.

query Parameters

name	string The name of the function to run.
args	object The optional args to be passed to the function or null.

Responses

@hash

@hash.sha1

Creates the SHA-1 hash from given input and returns it as hex string.

Search Academy for more details about: @hash.sha1.

query Parameters

input

object

input

object

input

object

input

object

The input data to create a hash from. Can be a string, a byte array or a collection of strings.

Responses

@hash.sha512Concat

Concatenates the given list of strings using the given separator and then calculates
the hash SHA-512 of the concatenated string.

Search Academy for more details about: @hash.sha512Concat.

query Parameters

separator	string The separator to be used to concat the string. If null, empty string will be used.
text	string The text (list) to concat into a string.

Responses

@hash.sha512Concat

Concatenates the given list of strings using the given separator and then calculates
the hash SHA-512 of the concatenated string.

Search Academy for more details about: @hash.sha512Concat.

query Parameters

separator	string The separator to be used to concat the string. If null, empty string will be used.
textList	collection The text (list) to concat into a string.

Responses

@i18n

@i18n.message

Returns the message for given app, context, key and locale.

Search Academy for more details about: @i18n.message.

query Parameters

app	string The app to lookup the i18n messages inside. If null or empty, app "common" will be used.
context	string The context to be used. If null or empty, "default" will be used.
key	string The message key.
locale	string The locale to be used. Must be a string of format language-country-variant, whereas country and variant are optional. For example: de-DE.

Responses

@i18n.message

Returns the translated message for given i18n uri string such as $uri:i18n:io.pipeforce.myapp/default/confirm.

Search Academy for more details about: @i18n.message.

query Parameters

i18nUri	string The uri string such as for example: $uri:i18n:io.pipeforce.myapp/default/confirm
locale	string The locale to be used. Must be a string of format language-country-variant, whereas country and variant are optional. For example: de-DE.

The email of the user.

Responses

@instance

@instance.env

Returns the value of the environment variable with given name.
Note that access to environment variables containing one of these substrings (case-insensitive) in the name
will be accessibly only by systemuser:

AUTH

BEARER

CREDENTIAL

PASS

SECRET

SECURE

SEED

TOKEN

Search Academy for more details about: @instance.env.

query Parameters

name	string The name of the environment variable.

Responses

@instance.domain

Returns the domain, this hub instance is currently running in. For example: pipeforce.net

Search Academy for more details about: @instance.domain.

Responses

@instance.namespace

Returns the namespace, this hub instance is currently running in. For example: latest

Search Academy for more details about: @instance.namespace.

Responses

@instance.url

Returns the full url for a given service in the current namespace. For example:
a call with 'workflow' could return 'http://workflow-myamespace.pipeforce.net' depending
on the namespace and domain configured for this instance.

Search Academy for more details about: @instance.url.

query Parameters

serviceName

string

The PIPEFORCE service name.

Responses

@instance.url

Returns the base url of the instance. For example: https://acme.pipeforce.net.

Search Academy for more details about: @instance.url.

Responses

@instance.profiles

The active profiles this instance is tagged with to run as.

Search Academy for more details about: @instance.profiles.

Responses

@instance.hasProfile

Checks if this instance contains at least one profile from the given list.

Search Academy for more details about: @instance.hasProfile.

query Parameters

profiles

@instance.defaultImageRepo

Prefixes the given image by the path of the default container image repository.
When running inside GKE this is typically: gcr.io/pipeforce/[image]

Search Academy for more details about: @instance.defaultImageRepo.

query Parameters

image

string

The image name to be prefixed by the repo.

Responses

@json

@json.load

Loads the given source and converts it into a JSONful data object.

Search Academy for more details about: @json.load.

query Parameters

source

object

@json.array

Creates a new, empty JSON array (as list) and returns it.

Search Academy for more details about: @json.array.

Responses

@list

@list.first

Returns the first element in list.

Search Academy for more details about: @list.first.

query Parameters

value

object

Any supported list object.

Responses

@list.last

Returns the last element in list.

Search Academy for more details about: @list.last.

query Parameters

value

object

Any supported list object.

Responses

@list.size

Returns the size of the given list.
DEPRECATED. Use ''@data.size(...)'' instead.

Search Academy for more details about: @list.size.

query Parameters

list	object The list.

Responses

@list.empty

Checks if given list is null or empty.
DEPRECATED. Use ''@data.isEmpty(...)'' instead.

Search Academy for more details about: @list.empty.

query Parameters

list	object The list to check.

Responses

@list.sublist

Utility to get a subset from a list using a list expression. Examples:

last - Returns the last element in the list.

first - Returns the first element in the list.

START:END - Returns all elements as a sublist from START (inclusive) up to the
given END (inclusive).

INDEX: - Returns all elements as a sublist from INDEX (inclusive) up to the
end of the list.

:INDEX - Returns all elements as a sublist from 0 up to INDEX (inclusive).

Search Academy for more details about: @list.sublist.

query Parameters

value	object Any list object.
expression	string The list expression.

Responses

@list.add

Appends the given element to the end of the given list.
This method is useful in case the list implementation is not clear since
this method can detect it (for example whether it is a collection or a JSON array).
By default doesn't add null items.

Search Academy for more details about: @list.add.

query Parameters

list	object The list to append to.
element	object The element to append.

Responses

@list.add

Appends the given element to the end of the given list.
This method is useful in case the list implementation is not clear since
this method can detect it (for example whether it is a collection or a JSON array).

Search Academy for more details about: @list.add.

query Parameters

list	object The list to append to.
element	object The element to append.
ignoreNulls	boolean If true, null items will not be added.

Responses

@list.remove

Removes the entry from the given list and shifts any subsequent element to the left.

Search Academy for more details about: @list.remove.

query Parameters

list	object The list to remove the element from.
index	int The index of the item to remove.

Responses

@list.contains

Searches the given list for the given needle.

Search Academy for more details about: @list.contains.

query Parameters

list	object The list to search in.
needles	object The items to search for. Can also be a list of items.

Responses

@list.create

Creates a new empty list.

Search Academy for more details about: @list.create.

Responses

@list.createNulled

Creates a new list of given size will all entries set to null.

Search Academy for more details about: @list.createNulled.

query Parameters

size	int The number of items to initialize the list with.

Responses

@list.create

Creates a new empty list.

Search Academy for more details about: @list.create.

query Parameters

items

object

The items to be set on the new list. Can be string, a collection or JSON. If it is a string
and contains a comma, it will be split into a list by comma.

Responses

@list.copy

Creates a flat copy of given list and returns it as new list.

Search Academy for more details about: @list.copy.

query Parameters

list	collection The list to create a flat copy from.

Responses

@path

@path.join

Concats all given items to a single path. Also see {@link PathUtil#path(Object...)}.

Search Academy for more details about: @path.join.

query Parameters

pathItems

object

The path items to join as list.

Responses

@path.extension

Returns the extension of a given filename (path).

Search Academy for more details about: @path.extension.

query Parameters

path	string The path string.

Responses

@path.basename

Returns the base name of a file without the extension. Also strips-off any
ID form the filename.
For example: "/folder/invoice.pdf" would return "invoice" and
"/folder/invoice_ID-3fgh343.pdf" would return "invoice"

Search Academy for more details about: @path.basename.

query Parameters

path	string The path string.

Responses

@property

@property.value

Returns the property value by given key from the property store.

Search Academy for more details about: @property.value.

query Parameters

key	string The property key

Responses

@property.values

Returns the values of all properties matching the given key pattern.

Search Academy for more details about: @property.values.

query Parameters

pattern

string

key	string The property key with optional fragment reference in form 'global/pathsegment1/pathsegment...#fragment'

Responses

@resolve

@resolve.uri

Resolves the given uri to its object representation. Supported uri schemes:

uri:user:Resolves to an user object.

uri:pipeline:Resolves the given path, pointing to a persisted pipeline, executes it
and returns the body result.

uri:property: Resolves the given property key path and returns it from the storage.

Search Academy for more details about: @resolve.uri.

query Parameters

uri	string The uri to be resolved.

Responses

@script

@script.groovy

Evaluates the given groovy script.

Search Academy for more details about: @script.groovy.

query Parameters

script	string The script to execute
args	object The variables to be passed to the script as args.

Responses

@script.groovy

Evaluates the given groovy script.

Search Academy for more details about: @script.groovy.

query Parameters

script

string

The script to execute

Responses

@text

@text.upperCase

Converts the given text value to upper case.

Search Academy for more details about: @text.upperCase.

query Parameters

text	object The text to convert.

Responses

@text.lastIndexOf

Returns the index of last occurrence of needle in the given text.

Search Academy for more details about: @text.lastIndexOf.

query Parameters

text	object The text to search for occurrence.
needle	object The text to search for.

Responses

@text.lastIndexOf

Returns the index of last occurrence of needle in the given text.

Search Academy for more details about: @text.lastIndexOf.

query Parameters

text	object The text to search for occurrence.
needle	object The text to search for.
offset	int The index to start search from.

Responses

@text.indexOf

Returns the index of the first occurrence of needle in the given text.

Search Academy for more details about: @text.indexOf.

query Parameters

text	object The text to search for occurrence.
needle	object The text to search for.

Responses

@text.indexOf

Returns the index of the first occurrence of needle in the given text.

Search Academy for more details about: @text.indexOf.

query Parameters

text	object The text to search for occurrence.
needle	object The text to search for.
offset	int The index to start search from.

Responses

@text.prefix

Returns the part from the beginning of the given text up to the stop word.
For example "Foo Bar" with stop word of " " would return "Foo" as prefix.

Search Academy for more details about: @text.prefix.

query Parameters

text	object The text.
stop	object The stop word.

Responses

@text.suffix

Returns the part from the stop word of the given text up to the end of the word.
For example "Foo Bar" with stop word of " " would return "Bar" as suffix.

Search Academy for more details about: @text.suffix.

query Parameters

text	object The text.
stop	object The stop word.

Responses

@text.lowerCase

Converts the given text value to lower case.

Search Academy for more details about: @text.lowerCase.

query Parameters

text	object The text.

Responses

@text.isEmpty

Returns true if given text is empty or null.

Search Academy for more details about: @text.isEmpty.

query Parameters

text	object The text.

Responses

@text.shorten

Shorts the given string and adds ... at the end.

Search Academy for more details about: @text.shorten.

query Parameters

text	object The text to shorten.
length	int The length.

Responses

@text.length

Returns the len of the given text. In case the text is null, 0 is returned.

Search Academy for more details about: @text.length.

query Parameters

text	object The text.

Responses

@text.contains

Checks whether given text contains at least one of given needle texts, ignoring case.
Also value and text can be null.

Search Academy for more details about: @text.contains.

query Parameters

text	object The text to search in.
needles	string A comma separated list of needles to search inside text.

Responses

@text.lang

Tries to detect the language of given text.

Search Academy for more details about: @text.lang.

query Parameters

text	object The text to detect the language for.

Responses

@text.random

Creates a random alphanumeric string of given size. Characters will be used from
a set of Latin alphabetic characters (a-z, A-Z) and the digits 0-9. No special chars.

Search Academy for more details about: @text.random.

query Parameters

size	int The length of the random string.

Responses

query Parameters

collection

object

value

string

input text to escape

Responses

@uri

@uri.resolve

Note: This function is deprecated. Use '@resolve.uri' instead.

Search Academy for more details about: @uri.resolve.

query Parameters

uri	string The uri to be resolved.

Responses

@user

@user.username

Returns the username of the currently logged-in user.

Search Academy for more details about: @user.username.

Responses

@user.uuid

Returns the uuid of the logged-in user.

Search Academy for more details about: @user.uuid.

Responses

@user.hasPermission

Returns true in case the logged-in user has at least one of the listed permission.

Search Academy for more details about: @user.hasPermission.

query Parameters

permissionKeys

string

Returns the preferred zoneId of the currently logged-in user or null in case none was set.
The preferred zone is usually set in the users profile or by the client in use (e.g. the browser).
See {@link ZoneId#getAvailableZoneIds()} and here: http://www.iana.org/time-zones

Search Academy for more details about: @user.zone.

Responses

@xml

@xml.xpath

Evaluates given XPath expression of given document and returns the result as a list of DOM nodes.

Search Academy for more details about: @xml.xpath.

query Parameters

document	object The document to be applied. Can be a DOM or an XML string.
xpath	string The expression to be applied.

Responses

@xml.xpathAsText

Evaluates given XPath expression of given document and returns the result as a text value.

Search Academy for more details about: @xml.xpathAsText.

query Parameters

document	object The document to be applied. Can be a DOM or an XML string.
xpath	string The expression to be applied.

PIPEFORCE REST API (v3)

Pipeline API

/pipeline

header Parameters

Request Body schema: application/yamlapplication/jsonmultipart/form-dataapplication/yaml

Responses

Request samples

Response samples

/pipeline:{path}

path Parameters

header Parameters

Responses

Response samples

/pipeline:{path}

path Parameters

Responses

Response samples

/pipeline:{path}

path Parameters

Responses

Response samples

/pipeline:{path}

path Parameters

/pipeline:uuid:{uuid}

/pipeline:uuid:{uuid}

/pipeline:uuid:{uuid}

/pipeline:uuid:{uuid}

Property API

/property:{path}

/property:{path}

/property:{path}

/property-uuid:{uuid}

/property-uuid:{uuid}

/property-uuid:{uuid}

/resource/{app}/{path}

ai

ai.intent.detect

query Parameters

Responses

ai.prompt.send

query Parameters

Responses

app

app.config.list

query Parameters

Responses

app.config.value.get

query Parameters

Responses

app.install

query Parameters

Responses

app.marketplace.search

query Parameters

Responses

app.name.list

query Parameters

Responses

app.resource.get

query Parameters

Responses

app.tile.list

query Parameters

Responses

app.uninstall

query Parameters

Responses

app.update

query Parameters

Responses

assert

assert

query Parameters

Responses

audit

audit.log

query Parameters

Responses

barcode

barcode.create

Request Body schema:
application/yaml